@compassdigital/sdk.typescript 4.569.0 → 4.571.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.569.0",
+	"version": "4.571.0",
 	"description": "Compass Digital Labs TypeScript SDK",
 	"type": "commonjs",
 	"main": "./lib/index.js",

package/src/index.ts

@@ -1422,6 +1422,9 @@ import {
 	PostRewardsQuery,
 	PostRewardsBody,
 	PostRewardsResponse,
+	PostDiscountValidateDiscountsQuery,
+	PostDiscountValidateDiscountsBody,
+	PostDiscountValidateDiscountsResponse,
 	PutDiscountPublishBody,
 	PutDiscountPublishResponse,
 } from './interface/discount';
@@ -16044,6 +16047,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /discount/validate-discounts - Validate and calculate discounts for a shopping cart
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_discount_validate_discounts(
+		body: PostDiscountValidateDiscountsBody,
+		options?: {
+			query?: PostDiscountValidateDiscountsQuery;
+		} & RequestOptions,
+	): ResponsePromise<PostDiscountValidateDiscountsResponse> {
+		return this.request(
+			'discount',
+			'/discount/validate-discounts',
+			'POST',
+			`/discount/validate-discounts`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * PUT /discount/{id}/publish - Publish a discount
 	 *

package/src/interface/discount.ts

@@ -259,6 +259,7 @@ export interface DiscountTaxonomy {
 export interface PostDiscountRequestDTO {
 	// What the discount type is
 	type: 'Total Order' | 'Single Items' | 'Bundle';
+	createdBy: string;
 	name: string;
 	is?: DiscountIs;
 	meta?: DiscountMeta;
@@ -267,7 +268,6 @@ export interface PostDiscountRequestDTO {
 	itemLevelConfig?: ItemLevelConfig;
 	taxonomy?: DiscountTaxonomy;
 	status?: DiscountStatus;
-	createdBy: string;
 }
 
 export interface PostDiscountResponseDTO {
@@ -393,18 +393,82 @@ export interface PostRewardsResponseDTO {
 	campaigns: CustomerRewardCampaignDTO[];
 }
 
-export interface PutDiscountRequestDTO {
+export interface UsedPaymentMethodsDTO {
+	hasMealplan?: boolean;
+	hasMealSwipes?: boolean;
+	hasMealExchange?: boolean;
+	hasBadgePay?: boolean;
+	hasStipend?: boolean;
+	hasVoucher?: boolean;
+	hasCouponVoucher?: boolean;
+	hasPaymentWallet?: boolean;
+	hasCreditCard?: boolean;
+}
+
+export interface PostValidateDiscountsRequestDTO {
+	// Site ID
+	siteId: string;
+	// Brand IDs
+	brandIds: string[];
+	// Shopping cart ID
+	cartId: string;
+	// Total cart amount
+	cartTotal: number;
+	// ISO 8601 creation date
+	createdDate: string;
+	// Currency code
+	currency: string;
+	// Payment methods used in the cart
+	usedPaymentMethods?: UsedPaymentMethodsDTO;
+	// Total of other incentives already applied
+	currentIncentivesTotal?: number;
+	// Customer ID for personalized discounts
+	customerId?: string;
+	// Items in the cart
+	cartItems: Record<string, any>[];
+}
+
+export interface StackedDiscountDTO {
+	// discount id
+	id: string;
+	// user id of discount creator
+	createdBy: string;
+	// user id of most recent update
+	updatedBy: string;
 	// What the discount type is
 	type: 'Total Order' | 'Single Items' | 'Bundle';
+	// Applied discount amount
+	appliedAmount: number;
+	createdAt: string;
+	updatedAt: string;
 	name: string;
+	status: DiscountStatus;
 	is?: DiscountIs;
 	meta?: DiscountMeta;
 	schedule?: DiscountSchedule;
 	channelConfig: DiscountChannelConfig;
 	itemLevelConfig?: ItemLevelConfig;
+}
+
+export interface PostValidateDiscountsResponseDTO {
+	// Total stacked discount amount
+	stackedTotal: number;
+	// List of validated and applied discounts
+	stackedDiscounts: StackedDiscountDTO[];
+}
+
+export interface PutDiscountRequestDTO {
+	// What the discount type is
+	type: 'Total Order' | 'Single Items' | 'Bundle';
 	updatedBy: string;
 	taxonomy?: DiscountTaxonomy;
 	status?: DiscountStatus;
+	name: string;
+	is?: DiscountIs;
+	meta?: DiscountMeta;
+	schedule?: DiscountSchedule;
+	channelConfig: DiscountChannelConfig;
+	itemLevelConfig?: ItemLevelConfig;
 }
 
 export interface PutDiscountResponseDTO {
@@ -441,15 +505,15 @@ export interface PutDiscountPublishResponseDTO {
 	updatedBy: string;
 	// What the discount type is
 	type: 'Total Order' | 'Single Items' | 'Bundle';
+	is: DiscountIs;
+	meta: DiscountMeta;
+	schedule: DiscountSchedule;
+	channelConfig: DiscountChannelConfig;
 	createdAt: string;
 	updatedAt: string;
 	name: string;
 	status: DiscountStatus;
 	itemLevelConfig?: ItemLevelConfig;
-	is: DiscountIs;
-	meta: DiscountMeta;
-	schedule: DiscountSchedule;
-	channelConfig: DiscountChannelConfig;
 }
 
 // DELETE /discount/{id} - Delete a discount
@@ -529,6 +593,17 @@ export type PostRewardsBody = PostRewardsBodyDTO;
 
 export type PostRewardsResponse = PostRewardsResponseDTO;
 
+// POST /discount/validate-discounts - Validate and calculate discounts for a shopping cart
+
+export interface PostDiscountValidateDiscountsQuery {
+	statusFilter?: string;
+	validateSchedule?: boolean;
+}
+
+export type PostDiscountValidateDiscountsBody = PostValidateDiscountsRequestDTO;
+
+export type PostDiscountValidateDiscountsResponse = PostValidateDiscountsResponseDTO;
+
 // PUT /discount/{id}/publish - Publish a discount
 
 export interface PutDiscountPublishPath {

package/src/interface/menu.ts

@@ -41,6 +41,8 @@ export interface Menu {
 		last_modified_user?: string;
 		centricos?: boolean;
 		version?: number;
+		// Unique identifier regenerated on every publish. Consumers can compare against a previously seen value to detect whether the V2 menu has changed (e.g. to de-dupe sync events).
+		revision?: string;
 		// V3 Brand metadata if menu came from Centric
 		brand?: {
 			id?: string;