@compassdigital/sdk.typescript 4.528.0 → 4.528.1-alpha.3

package/src/interface/loyalty.ts

@@ -0,0 +1,1158 @@
+/* eslint-disable */
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+import { RequestQuery, BaseRequest } from './util';
+
+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 {
+	// 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 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' | 'loyalty_reward';
+	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';
+	// YYYY-MM-DD
+	startDate?: string | null;
+	// YYYY-MM-DD
+	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;
+	// HH:MM:SS format
+	startTime: string;
+	// HH:MM:SS format
+	endTime: string;
+}
+
+export interface CampaignEligibilityResponseDto {
+	id: string;
+	campaignId: string;
+	eligibilityType: 'everyone' | 'meal_plan' | 'badge_pay' | 'sso_group' | 'segment';
+	ssoGroupId?: string | null;
+	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' | 'loyalty_reward';
+	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';
+	// YYYY-MM-DD
+	startDate?: string | null;
+	// YYYY-MM-DD
+	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[];
+}
+
+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 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;
+	// Supports legacy alias "binding"
+	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;
+	// Supports legacy alias "binding"
+	codeType: 'open' | 'personal';
+	// Prefix prepended to generated codes
+	prefix?: string;
+	expiresAt?: string;
+	// Required when codeType = personal; length must match count
+	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;
+}
+
+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 SegmentResponseDto {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	deletedAt?: string | null;
+	createdBy: string;
+	realm: 'boost' | 'thrive';
+	siteId: string;
+	name: string;
+	description?: string | null;
+	type: 'static_list' | 'sso_group' | 'attribute_rule';
+	ssoGroupId?: string | null;
+	ruleJson?: Record<string, any> | null;
+	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';
+	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 SegmentMemberResponseDto {
+	customerId: string;
+	addedAt: string;
+	addedBy: string;
+}
+
+export interface SegmentMembersListResponseDto {
+	data: SegmentMemberResponseDto[];
+	pagination: SegmentPaginationDto;
+}
+
+export interface SegmentMembersDto {
+	// List of customer IDs
+	customerIds: string[];
+}
+
+export interface AddSegmentMembersResponseDto {
+	added: number;
+}
+
+export interface RemoveSegmentMembersResponseDto {
+	removed: number;
+}
+
+export interface RollbackRedemptionDto {
+	// Reason for rolling back the redemption
+	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';
+}
+
+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;
+	// Stations excluded from earning on this rule
+	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';
+	name: string;
+	description?: string | null;
+	status: 'active' | 'paused' | 'archived';
+	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 {
+	// Positive to add, negative to deduct
+	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;
+	alreadyProcessed: boolean;
+	pointsAwarded: number;
+	issuedVoucherCodes: string[];
+}
+
+// GET /loyalty/bundles - List bundles with optional filters
+
+export interface GetLoyaltyBundlesQuery {
+	// Max items to return
+	limit?: number;
+	// Opaque cursor from previous response
+	cursor?: string;
+	realm?: 'boost' | 'thrive';
+	siteId?: string;
+	siteIds?: string[];
+	name?: string;
+}
+
+export type GetLoyaltyBundlesResponse = BundleListResponseDto;
+
+// POST /loyalty/bundles - Create a new bundle
+
+export type PostLoyaltyBundleBody = CreateBundleDto;
+
+export type PostLoyaltyBundleResponse = BundleDetailResponseDto;
+
+// GET /loyalty/bundles/{id} - Get bundle by ID with groups
+
+export interface GetLoyaltyBundlePath {
+	id: string;
+}
+
+export type GetLoyaltyBundleResponse = BundleDetailResponseDto;
+
+// PATCH /loyalty/bundles/{id} - Update a bundle
+
+export interface PatchLoyaltyBundlePath {
+	id: string;
+}
+
+export type PatchLoyaltyBundleBody = UpdateBundleDto;
+
+export type PatchLoyaltyBundleResponse = BundleDetailResponseDto;
+
+// DELETE /loyalty/bundles/{id} - Soft-delete a bundle
+
+export interface DeleteLoyaltyBundlePath {
+	id: string;
+}
+
+export type DeleteLoyaltyBundleResponse = {};
+
+// GET /loyalty/campaigns - List campaigns with filters and pagination
+
+export interface GetLoyaltyCampaignsQuery {
+	// 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 GetLoyaltyCampaignsResponse = CampaignListResponseDto;
+
+// POST /loyalty/campaigns - Create a campaign with nested child entities
+
+export type PostLoyaltyCampaignBody = CreateCampaignDto;
+
+export type PostLoyaltyCampaignResponse = CampaignDetailResponseDto;
+
+// GET /loyalty/campaigns/{id} - Get campaign detail with all child entities
+
+export interface GetLoyaltyCampaignPath {
+	id: string;
+}
+
+export type GetLoyaltyCampaignResponse = CampaignDetailResponseDto;
+
+// PUT /loyalty/campaigns/{id} - Update a campaign and its child entities
+
+export interface PutLoyaltyCampaignPath {
+	id: string;
+}
+
+export type PutLoyaltyCampaignBody = UpdateCampaignDto;
+
+export type PutLoyaltyCampaignResponse = CampaignDetailResponseDto;
+
+// DELETE /loyalty/campaigns/{id} - Soft-delete a campaign
+
+export interface DeleteLoyaltyCampaignPath {
+	id: string;
+}
+
+export type DeleteLoyaltyCampaignResponse = {};
+
+// PATCH /loyalty/campaigns/{id}/status - Transition campaign status
+
+export interface PatchLoyaltyCampaignStatusPath {
+	id: string;
+}
+
+export type PatchLoyaltyCampaignStatusBody = UpdateCampaignStatusDto;
+
+export type PatchLoyaltyCampaignStatusResponse = CampaignDetailResponseDto;
+
+// POST /loyalty/campaigns/{id}/clone - Deep clone a campaign and all child entities
+
+export interface PostLoyaltyCampaignClonePath {
+	id: string;
+}
+
+export type PostLoyaltyCampaignCloneResponse = CampaignDetailResponseDto;
+
+// GET /loyalty/vouchers - List vouchers with optional filters
+
+export interface GetLoyaltyVouchersQuery {
+	// 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 GetLoyaltyVouchersResponse = VoucherListResponseDto;
+
+// POST /loyalty/vouchers - Create a single voucher
+
+export type PostLoyaltyVoucherBody = CreateVoucherDto;
+
+export type PostLoyaltyVoucherResponse = VoucherResponseDto;
+
+// GET /loyalty/vouchers/{id} - Get voucher by ID with campaign info and redemption count
+
+export interface GetLoyaltyVoucherPath {
+	id: string;
+}
+
+export type GetLoyaltyVoucherResponse = VoucherResponseDto;
+
+// PUT /loyalty/vouchers/{id} - Update a voucher
+
+export interface PutLoyaltyVoucherPath {
+	id: string;
+}
+
+export type PutLoyaltyVoucherBody = UpdateVoucherDto;
+
+export type PutLoyaltyVoucherResponse = VoucherResponseDto;
+
+// DELETE /loyalty/vouchers/{id} - Soft-delete a voucher
+
+export interface DeleteLoyaltyVoucherPath {
+	id: string;
+}
+
+export type DeleteLoyaltyVoucherResponse = {};
+
+// POST /loyalty/vouchers/{id}/revoke - Revoke a voucher with a required reason
+
+export interface PostLoyaltyVoucherRevokePath {
+	id: string;
+}
+
+export type PostLoyaltyVoucherRevokeBody = RevokeVoucherDto;
+
+export type PostLoyaltyVoucherRevokeResponse = VoucherResponseDto;
+
+// POST /loyalty/vouchers/batch - Batch generate voucher codes for a campaign
+
+export type PostLoyaltyVouchersBatchBody = BatchVoucherDto;
+
+export type PostLoyaltyVouchersBatchResponse = BatchVoucherResponseDto;
+
+// GET /loyalty/vouchers/{id}/redemptions - Get redemption history for a voucher
+
+export interface GetLoyaltyVoucherRedemptionsPath {
+	id: string;
+}
+
+export interface GetLoyaltyVoucherRedemptionsQuery {
+	// Max items to return
+	limit?: number;
+	// Opaque cursor from previous response
+	cursor?: string;
+}
+
+export type GetLoyaltyVoucherRedemptionsResponse = RedemptionListResponseDto;
+
+// POST /loyalty/vouchers/validate - Validate one or more voucher codes
+
+export type PostLoyaltyVouchersValidateBody = VoucherOperationDto;
+
+export type PostLoyaltyVouchersValidateResponse = VoucherOperationResponseDto;
+
+// POST /loyalty/vouchers/redeem - Redeem one or more voucher codes
+
+export type PostLoyaltyVouchersRedeemBody = VoucherOperationDto;
+
+export type PostLoyaltyVouchersRedeemResponse = VoucherOperationResponseDto;
+
+// GET /loyalty/segments - List segments with optional filters
+
+export interface GetLoyaltySegmentsQuery {
+	// 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 GetLoyaltySegmentsResponse = SegmentListResponseDto;
+
+// POST /loyalty/segments - Create a new segment
+
+export type PostLoyaltySegmentBody = CreateSegmentDto;
+
+export type PostLoyaltySegmentResponse = SegmentResponseDto;
+
+// GET /loyalty/segments/attributes - List available attributes for rule-based segments
+
+export type GetLoyaltySegmentAttributesResponse = SegmentAttributeResponseDto[];
+
+// POST /loyalty/segments/preview-count - Preview how many customers match a segment rule
+
+export type PostLoyaltySegmentPreviewCountResponse = SegmentPreviewCountResponseDto;
+
+// GET /loyalty/segments/{id} - Get segment by ID
+
+export interface GetLoyaltySegmentPath {
+	id: string;
+}
+
+export type GetLoyaltySegmentResponse = SegmentResponseDto;
+
+// PATCH /loyalty/segments/{id} - Update a segment
+
+export interface PatchLoyaltySegmentPath {
+	id: string;
+}
+
+export type PatchLoyaltySegmentBody = UpdateSegmentDto;
+
+export type PatchLoyaltySegmentResponse = SegmentResponseDto;
+
+// DELETE /loyalty/segments/{id} - Soft-delete a segment
+
+export interface DeleteLoyaltySegmentPath {
+	id: string;
+}
+
+export type DeleteLoyaltySegmentResponse = {};
+
+// GET /loyalty/segments/{id}/members - List members of a static_list segment
+
+export interface GetLoyaltySegmentMembersPath {
+	id: string;
+}
+
+export interface GetLoyaltySegmentMembersQuery {
+	// Max items to return
+	limit?: number;
+	// Opaque cursor from previous response
+	cursor?: string;
+}
+
+export type GetLoyaltySegmentMembersResponse = SegmentMembersListResponseDto;
+
+// POST /loyalty/segments/{id}/members - Add members to a segment
+
+export interface PostLoyaltySegmentMembersPath {
+	id: string;
+}
+
+export type PostLoyaltySegmentMembersBody = SegmentMembersDto;
+
+export type PostLoyaltySegmentMembersResponse = AddSegmentMembersResponseDto;
+
+// DELETE /loyalty/segments/{id}/members - Remove members from a segment
+
+export interface DeleteLoyaltySegmentMembersPath {
+	id: string;
+}
+
+export type DeleteLoyaltySegmentMembersBody = SegmentMembersDto;
+
+export type DeleteLoyaltySegmentMembersResponse = RemoveSegmentMembersResponseDto;
+
+// POST /loyalty/redemptions/{id}/rollback - Roll back a redemption and restore the voucher
+
+export interface PostLoyaltyRedemptionRollbackPath {
+	id: string;
+}
+
+export type PostLoyaltyRedemptionRollbackBody = RollbackRedemptionDto;
+
+export type PostLoyaltyRedemptionRollbackResponse = RedemptionResponseDto;
+
+// GET /loyalty/rewards - List rewards with filters and pagination
+
+export interface GetLoyaltyRewardsQuery {
+	// Max items to return
+	limit?: number;
+	// Opaque cursor from previous response
+	cursor?: string;
+	realm?: 'boost' | 'thrive';
+	status?: 'active' | 'paused' | 'archived';
+}
+
+export type GetLoyaltyRewardsResponse = RewardListResponseDto;
+
+// POST /loyalty/rewards - Create a reward with earning rules and milestones
+
+export type PostLoyaltyRewardBody = CreateRewardDto;
+
+export type PostLoyaltyRewardResponse = RewardDetailResponseDto;
+
+// GET /loyalty/rewards/{id} - Get reward detail with earning rules and milestones
+
+export interface GetLoyaltyRewardPath {
+	id: string;
+}
+
+export type GetLoyaltyRewardResponse = RewardDetailResponseDto;
+
+// PUT /loyalty/rewards/{id} - Update a reward and replace its earning rules and milestones
+
+export interface PutLoyaltyRewardPath {
+	id: string;
+}
+
+export type PutLoyaltyRewardBody = UpdateRewardDto;
+
+export type PutLoyaltyRewardResponse = RewardDetailResponseDto;
+
+// PATCH /loyalty/rewards/{id}/status - Transition reward status
+
+export interface PatchLoyaltyRewardStatusPath {
+	id: string;
+}
+
+export type PatchLoyaltyRewardStatusBody = UpdateRewardStatusDto;
+
+export type PatchLoyaltyRewardStatusResponse = RewardDetailResponseDto;
+
+// GET /loyalty/rewards/{id}/cards - List enrolled customer cards for a reward
+
+export interface GetLoyaltyRewardCardsPath {
+	id: string;
+}
+
+export interface GetLoyaltyRewardCardsQuery {
+	// Max items to return
+	limit?: number;
+	// Opaque cursor from previous response
+	cursor?: string;
+}
+
+export type GetLoyaltyRewardCardsResponse = RewardCardListResponseDto;
+
+// GET /loyalty/rewards/{id}/cards/{customerId} - Get card detail with transaction event history
+
+export interface GetLoyaltyRewardCardPath {
+	id: string;
+	customerId: string;
+}
+
+export type GetLoyaltyRewardCardResponse = RewardCardDetailResponseDto;
+
+// POST /loyalty/rewards/cards/{cardId}/adjust - Manual point adjustment on a reward card
+
+export interface PostLoyaltyRewardCardAdjustPath {
+	cardId: string;
+}
+
+export type PostLoyaltyRewardCardAdjustBody = AdjustPointsDto;
+
+export type PostLoyaltyRewardCardAdjustResponse = RewardCardDetailResponseDto;
+
+// POST /loyalty/rewards/orders/earn - Evaluate an order against active reward rules and award points idempotently
+
+export type PostLoyaltyRewardOrderEarnBody = EarnOrderDto;
+
+export type PostLoyaltyRewardOrderEarnResponse = EarnOrderResponseDto;