@compassdigital/sdk.typescript 4.528.0 → 4.528.1-beta.0

package/src/interface/loyalty.ts

@@ -0,0 +1,659 @@
+/* eslint-disable */
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+import { RequestQuery, BaseRequest } from './util';
+
+export interface ErrorDisplayMessage {
+	// user message title
+	title: string;
+	// user message description
+	description: string;
+}
+
+export interface ErrorData {
+	// http status code
+	statusCode: number;
+	// http status text
+	statusText: string;
+	timestamp: string;
+	// user friendly error message
+	displayMessage: ErrorDisplayMessage;
+}
+
+export interface Error {
+	// business error code
+	code: number;
+	// business error description
+	message: string;
+	// additional error data
+	data: ErrorData;
+}
+
+export interface BundleGroupDto {
+	groupName: string;
+	minimumQuantity: number;
+	itemIds: string[];
+}
+
+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 DailyScheduleDto {
+	dayOfWeek: 'mon' | 'tue' | 'wed' | 'thu' | 'fri' | 'sat' | 'sun';
+	active: boolean;
+	// HH:MM:SS format
+	startTime: string;
+	// HH:MM:SS format
+	endTime: string;
+}
+
+export interface EligibilityDto {
+	eligibilityType: 'everyone' | 'meal_plan' | 'badge_pay' | 'sso_group' | 'segment';
+	ssoGroupId?: string;
+	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' | 'loyalty_reward';
+	discountType: 'AMOUNT_OFF' | 'PERCENT_OFF' | 'FREE_ITEM';
+	discountScope: 'order' | 'items';
+	discountValueCents?: number;
+	discountPercent?: number;
+	appliesToCheapest?: boolean;
+	maxDiscountCents?: number;
+	codeType: 'open' | 'personal' | 'auto_applied';
+	// YYYY-MM-DD
+	startDate?: string;
+	// YYYY-MM-DD
+	endDate?: string;
+	maxRedemptions?: number;
+	maxRedemptionsPerCustomer?: number;
+	maxRedemptionsDaily?: number;
+	maxRedemptionsPerCustomerDaily?: number;
+	minOrderValueCents?: number;
+	maxOrderValueCents?: number;
+	dailySchedule?: DailyScheduleDto[];
+	eligibility?: EligibilityDto[];
+	siteScopes?: SiteScopeDto[];
+	stationScopes?: StationScopeDto[];
+	itemTargets?: ItemTargetDto[];
+	// Reference to a reusable bundle for cart-content conditions
+	bundleId?: string;
+}
+
+export interface UpdateCampaignDto {
+	realm?: 'boost' | 'thrive';
+	name?: string;
+	description?: string;
+	type?: 'promo_code' | 'auto_apply' | 'loyalty_reward';
+	discountType?: 'AMOUNT_OFF' | 'PERCENT_OFF' | 'FREE_ITEM';
+	discountScope?: 'order' | 'items';
+	discountValueCents?: number;
+	discountPercent?: number;
+	appliesToCheapest?: boolean;
+	maxDiscountCents?: number;
+	codeType?: 'open' | 'personal' | 'auto_applied';
+	// YYYY-MM-DD
+	startDate?: string;
+	// YYYY-MM-DD
+	endDate?: string;
+	maxRedemptions?: number;
+	maxRedemptionsPerCustomer?: number;
+	maxRedemptionsDaily?: number;
+	maxRedemptionsPerCustomerDaily?: number;
+	minOrderValueCents?: number;
+	maxOrderValueCents?: number;
+	dailySchedule?: DailyScheduleDto[];
+	eligibility?: EligibilityDto[];
+	siteScopes?: SiteScopeDto[];
+	stationScopes?: StationScopeDto[];
+	itemTargets?: ItemTargetDto[];
+	// Reference to a reusable bundle for cart-content conditions
+	bundleId?: string;
+}
+
+export interface UpdateCampaignStatusDto {
+	status: 'draft' | 'active' | 'paused' | 'expired' | 'archived';
+	reason?: string;
+}
+
+export interface CreateVoucherDto {
+	campaignId: string;
+	code: string;
+	codeType: 'open' | 'personal' | 'auto_applied';
+	// Required when codeType = personal
+	customerId?: string;
+	expiresAt?: string;
+	issueReason?: string;
+}
+
+export interface UpdateVoucherDto {
+	expiresAt?: string;
+	customerId?: string;
+}
+
+export interface RevokeVoucherDto {
+	// Reason for revoking the voucher
+	reason: string;
+}
+
+export interface BatchVoucherDto {
+	campaignId: string;
+	count: number;
+	codeType: 'open' | 'personal';
+	// Prefix prepended to generated codes
+	prefix?: string;
+	expiresAt?: string;
+	// Required when codeType = personal; length must match count
+	customerIds?: string[];
+}
+
+export interface CreateSegmentDto {
+	realm: 'boost' | 'thrive';
+	siteId: string;
+	name: string;
+	description?: string;
+	type: 'static_list' | 'sso_group' | 'attribute_rule';
+	// Required when type = sso_group
+	ssoGroupId?: string;
+	// Required when type = attribute_rule
+	ruleJson?: Record<string, any>;
+	// Initial members for static_list segments
+	customerIds?: string[];
+}
+
+export interface UpdateSegmentDto {
+	name?: string;
+	description?: string;
+	ssoGroupId?: string;
+	ruleJson?: Record<string, any>;
+}
+
+export interface SegmentMembersDto {
+	// List of customer IDs
+	customerIds: string[];
+}
+
+export interface RollbackRedemptionDto {
+	// Reason for rolling back the redemption
+	reason: string;
+}
+
+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;
+	// Stations excluded from earning on this rule
+	brandExclusions?: BrandExclusionDto[];
+}
+
+export interface MilestoneDto {
+	pointsRequired: number;
+	campaignId: string;
+	resetsAfterMilestone: boolean;
+	maxRewardCount?: number;
+}
+
+export interface CreateProgramDto {
+	realm: 'boost' | 'thrive';
+	name: string;
+	description?: string;
+	earningRules?: EarningRuleDto[];
+	milestones?: MilestoneDto[];
+}
+
+export interface UpdateProgramDto {
+	realm?: 'boost' | 'thrive';
+	name?: string;
+	description?: string;
+	earningRules?: EarningRuleDto[];
+	milestones?: MilestoneDto[];
+}
+
+export interface UpdateProgramStatusDto {
+	status: 'active' | 'paused' | 'archived';
+}
+
+export interface AdjustPointsDto {
+	// Positive to add, negative to deduct
+	pointsDelta: number;
+	description: string;
+}
+
+// GET /loyalty/bundles - List bundles with optional filters
+
+export interface BundleControllerFindAllQuery {
+	// Max items to return
+	limit?: number;
+	// Opaque cursor from previous response
+	cursor?: string;
+	realm?: 'boost' | 'thrive';
+	siteId?: string;
+	name?: string;
+}
+
+export type BundleControllerFindAllResponse = {};
+
+// POST /loyalty/bundles - Create a new bundle
+
+export type BundleControllerCreateBody = CreateBundleDto;
+
+export type BundleControllerCreateResponse = {};
+
+// GET /loyalty/bundles/{id} - Get bundle by ID with groups
+
+export interface BundleControllerFindOnePath {
+	id: string;
+}
+
+export type BundleControllerFindOneResponse = {};
+
+// PATCH /loyalty/bundles/{id} - Update a bundle
+
+export interface BundleControllerUpdatePath {
+	id: string;
+}
+
+export type BundleControllerUpdateBody = UpdateBundleDto;
+
+export type BundleControllerUpdateResponse = {};
+
+// DELETE /loyalty/bundles/{id} - Soft-delete a bundle
+
+export interface BundleControllerRemovePath {
+	id: string;
+}
+
+export type BundleControllerRemoveResponse = {};
+
+// GET /loyalty/campaigns - List campaigns with filters and pagination
+
+export interface CampaignControllerListQuery {
+	// Max items to return
+	limit?: number;
+	// Opaque cursor from previous response
+	cursor?: string;
+	realm?: 'boost' | 'thrive';
+	status?: 'draft' | 'active' | 'paused' | 'expired' | 'archived';
+	type?: 'promo_code' | 'auto_apply' | 'loyalty_reward';
+	// Case-insensitive partial name match
+	name?: string;
+	// YYYY-MM-DD
+	startDateFrom?: string;
+	// YYYY-MM-DD
+	startDateTo?: string;
+	// YYYY-MM-DD
+	endDateFrom?: string;
+	// YYYY-MM-DD
+	endDateTo?: string;
+	sortBy?: 'name' | 'createdAt' | 'startDate' | 'status';
+	sortOrder?: 'ASC' | 'DESC';
+}
+
+export type CampaignControllerListResponse = {};
+
+// POST /loyalty/campaigns - Create a campaign with nested child entities
+
+export type CampaignControllerCreateBody = CreateCampaignDto;
+
+export type CampaignControllerCreateResponse = {};
+
+// GET /loyalty/campaigns/{id} - Get campaign detail with all child entities
+
+export interface CampaignControllerFindOnePath {
+	id: string;
+}
+
+export type CampaignControllerFindOneResponse = {};
+
+// PUT /loyalty/campaigns/{id} - Update a campaign and its child entities
+
+export interface CampaignControllerUpdatePath {
+	id: string;
+}
+
+export type CampaignControllerUpdateBody = UpdateCampaignDto;
+
+export type CampaignControllerUpdateResponse = {};
+
+// DELETE /loyalty/campaigns/{id} - Soft-delete a campaign
+
+export interface CampaignControllerRemovePath {
+	id: string;
+}
+
+export type CampaignControllerRemoveResponse = {};
+
+// PATCH /loyalty/campaigns/{id}/status - Transition campaign status
+
+export interface CampaignControllerUpdateStatusPath {
+	id: string;
+}
+
+export type CampaignControllerUpdateStatusBody = UpdateCampaignStatusDto;
+
+export type CampaignControllerUpdateStatusResponse = {};
+
+// POST /loyalty/campaigns/{id}/clone - Deep clone a campaign and all child entities
+
+export interface CampaignControllerClonePath {
+	id: string;
+}
+
+export type CampaignControllerCloneResponse = {};
+
+// GET /loyalty/vouchers - List vouchers with optional filters
+
+export interface VoucherControllerFindAllQuery {
+	// Max items to return
+	limit?: number;
+	// Opaque cursor from previous response
+	cursor?: string;
+	campaignId?: string;
+	realm?: 'boost' | 'thrive';
+	status?: 'active' | 'redeemed' | 'expired' | 'revoked';
+	// Exact code match
+	code?: string;
+	codeType?: 'open' | 'personal' | 'auto_applied';
+	customerId?: string;
+}
+
+export type VoucherControllerFindAllResponse = {};
+
+// POST /loyalty/vouchers - Create a single voucher
+
+export type VoucherControllerCreateBody = CreateVoucherDto;
+
+export type VoucherControllerCreateResponse = {};
+
+// GET /loyalty/vouchers/{id} - Get voucher by ID with campaign info and redemption count
+
+export interface VoucherControllerFindOnePath {
+	id: string;
+}
+
+export type VoucherControllerFindOneResponse = {};
+
+// PUT /loyalty/vouchers/{id} - Update a voucher
+
+export interface VoucherControllerUpdatePath {
+	id: string;
+}
+
+export type VoucherControllerUpdateBody = UpdateVoucherDto;
+
+export type VoucherControllerUpdateResponse = {};
+
+// DELETE /loyalty/vouchers/{id} - Soft-delete a voucher
+
+export interface VoucherControllerRemovePath {
+	id: string;
+}
+
+export type VoucherControllerRemoveResponse = {};
+
+// POST /loyalty/vouchers/{id}/revoke - Revoke a voucher with a required reason
+
+export interface VoucherControllerRevokePath {
+	id: string;
+}
+
+export type VoucherControllerRevokeBody = RevokeVoucherDto;
+
+export type VoucherControllerRevokeResponse = {};
+
+// POST /loyalty/vouchers/batch - Batch generate voucher codes for a campaign
+
+export type VoucherControllerBatchGenerateBody = BatchVoucherDto;
+
+export type VoucherControllerBatchGenerateResponse = {};
+
+// GET /loyalty/vouchers/{id}/redemptions - Get redemption history for a voucher
+
+export interface VoucherControllerFindRedemptionsPath {
+	id: string;
+}
+
+export interface VoucherControllerFindRedemptionsQuery {
+	// Max items to return
+	limit?: number;
+	// Opaque cursor from previous response
+	cursor?: string;
+}
+
+export type VoucherControllerFindRedemptionsResponse = {};
+
+// POST /loyalty/vouchers/validate - Validate a voucher code (stub)
+
+export type VoucherControllerValidateResponse = {};
+
+// POST /loyalty/vouchers/redeem - Redeem a voucher code (stub)
+
+export type VoucherControllerRedeemResponse = {};
+
+// GET /loyalty/segments - List segments with optional filters
+
+export interface SegmentControllerFindAllQuery {
+	// Max items to return
+	limit?: number;
+	// Opaque cursor from previous response
+	cursor?: string;
+	realm?: 'boost' | 'thrive';
+	type?: 'static_list' | 'sso_group' | 'attribute_rule';
+	siteId?: string;
+	// Case-insensitive partial name match
+	name?: string;
+}
+
+export type SegmentControllerFindAllResponse = {};
+
+// POST /loyalty/segments - Create a new segment
+
+export type SegmentControllerCreateBody = CreateSegmentDto;
+
+export type SegmentControllerCreateResponse = {};
+
+// GET /loyalty/segments/attributes - List available attributes for rule-based segments
+
+export type SegmentControllerGetAttributesResponse = {};
+
+// POST /loyalty/segments/preview-count - Preview how many customers match a segment rule
+
+export type SegmentControllerPreviewRuleCountResponse = {};
+
+// GET /loyalty/segments/{id} - Get segment by ID
+
+export interface SegmentControllerFindOnePath {
+	id: string;
+}
+
+export type SegmentControllerFindOneResponse = {};
+
+// PATCH /loyalty/segments/{id} - Update a segment
+
+export interface SegmentControllerUpdatePath {
+	id: string;
+}
+
+export type SegmentControllerUpdateBody = UpdateSegmentDto;
+
+export type SegmentControllerUpdateResponse = {};
+
+// DELETE /loyalty/segments/{id} - Soft-delete a segment
+
+export interface SegmentControllerRemovePath {
+	id: string;
+}
+
+export type SegmentControllerRemoveResponse = {};
+
+// GET /loyalty/segments/{id}/members - List members of a static_list segment
+
+export interface SegmentControllerFindMembersPath {
+	id: string;
+}
+
+export interface SegmentControllerFindMembersQuery {
+	// Max items to return
+	limit?: number;
+	// Opaque cursor from previous response
+	cursor?: string;
+}
+
+export type SegmentControllerFindMembersResponse = {};
+
+// POST /loyalty/segments/{id}/members - Add members to a segment
+
+export interface SegmentControllerAddMembersPath {
+	id: string;
+}
+
+export type SegmentControllerAddMembersBody = SegmentMembersDto;
+
+export type SegmentControllerAddMembersResponse = {};
+
+// DELETE /loyalty/segments/{id}/members - Remove members from a segment
+
+export interface SegmentControllerRemoveMembersPath {
+	id: string;
+}
+
+export type SegmentControllerRemoveMembersBody = SegmentMembersDto;
+
+export type SegmentControllerRemoveMembersResponse = {};
+
+// POST /loyalty/redemptions/{id}/rollback - Roll back a redemption and restore the voucher
+
+export interface RedemptionControllerRollbackPath {
+	id: string;
+}
+
+export type RedemptionControllerRollbackBody = RollbackRedemptionDto;
+
+export type RedemptionControllerRollbackResponse = {};
+
+// GET /loyalty/loyalty/programs - List loyalty programs with filters and pagination
+
+export interface LoyaltyControllerListProgramsQuery {
+	// Max items to return
+	limit?: number;
+	// Opaque cursor from previous response
+	cursor?: string;
+	realm?: 'boost' | 'thrive';
+	status?: 'active' | 'paused' | 'archived';
+}
+
+export type LoyaltyControllerListProgramsResponse = {};
+
+// POST /loyalty/loyalty/programs - Create a loyalty program with earning rules and milestones
+
+export type LoyaltyControllerCreateProgramBody = CreateProgramDto;
+
+export type LoyaltyControllerCreateProgramResponse = {};
+
+// GET /loyalty/loyalty/programs/{id} - Get loyalty program detail with earning rules and milestones
+
+export interface LoyaltyControllerFindOneProgramPath {
+	id: string;
+}
+
+export type LoyaltyControllerFindOneProgramResponse = {};
+
+// PUT /loyalty/loyalty/programs/{id} - Update a loyalty program and replace its earning rules and milestones
+
+export interface LoyaltyControllerUpdateProgramPath {
+	id: string;
+}
+
+export type LoyaltyControllerUpdateProgramBody = UpdateProgramDto;
+
+export type LoyaltyControllerUpdateProgramResponse = {};
+
+// PATCH /loyalty/loyalty/programs/{id}/status - Transition loyalty program status
+
+export interface LoyaltyControllerUpdateProgramStatusPath {
+	id: string;
+}
+
+export type LoyaltyControllerUpdateProgramStatusBody = UpdateProgramStatusDto;
+
+export type LoyaltyControllerUpdateProgramStatusResponse = {};
+
+// GET /loyalty/loyalty/programs/{id}/cards - List enrolled customer cards for a program
+
+export interface LoyaltyControllerListCardsPath {
+	id: string;
+}
+
+export interface LoyaltyControllerListCardsQuery {
+	// Max items to return
+	limit?: number;
+	// Opaque cursor from previous response
+	cursor?: string;
+}
+
+export type LoyaltyControllerListCardsResponse = {};
+
+// GET /loyalty/loyalty/programs/{id}/cards/{customerId} - Get card detail with transaction event history
+
+export interface LoyaltyControllerFindCardPath {
+	id: string;
+	customerId: string;
+}
+
+export type LoyaltyControllerFindCardResponse = {};
+
+// POST /loyalty/loyalty/cards/{cardId}/adjust - Manual point adjustment on a loyalty card
+
+export interface LoyaltyControllerAdjustPointsPath {
+	cardId: string;
+}
+
+export type LoyaltyControllerAdjustPointsBody = AdjustPointsDto;
+
+export type LoyaltyControllerAdjustPointsResponse = {};