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

package/src/interface/centricos.ts

@@ -409,6 +409,10 @@ export interface DeleteStationResponse {
 	success: boolean;
 }
 
+export interface DeleteStationIntegrationResponse {
+	success: boolean;
+}
+
 export interface CentricDiscountChannelConfig {
 	thrive: boolean;
 	boost: boolean;
@@ -1343,6 +1347,16 @@ export interface PutCentricosStationIntegrationPath {
 
 export type PutCentricosStationIntegrationResponse = PutStationIntegrationResponse;
 
+// DELETE /centricos/station/{station_id}/{integration_type} - Delete station integration
+
+export interface DeleteCentricosStationIntegrationPath {
+	// TODO: cannot use CompassLongID as path parameter
+	station_id: string;
+	integration_type: string;
+}
+
+export type DeleteCentricosStationIntegrationResponse = DeleteStationIntegrationResponse;
+
 // PUT /centricos/discount/voucherify - Add or Update a voucherify discount and assign it to multiple sites
 
 export type PutCentricosDiscountVoucherifyBody = PutDiscountVoucherifyRequestDTO;
@@ -1504,15 +1518,11 @@ export type ListSwapsBody = SwapListRequestDto;
 
 export type ListSwapsResponse = SwapListResponseDto;
 
-// GET /centricos/swaps/details - Get detailed information about a swap recommendation
+// GET /centricos/swaps/details/{recommendation_id} - Get detailed information about a swap recommendation
 
-export interface GetSwapDetailsQuery {
+export interface GetSwapDetailsPath {
 	// Unique swap recommendation ID
 	recommendation_id: string;
-	// Centric item ID
-	item_id: string;
-	// Centric item POSID
-	pos_id: string;
 }
 
 export type GetSwapDetailsResponse = SwapDetailsResponseDto;

package/src/interface/consumer.ts

@@ -3513,6 +3513,35 @@ export interface ConsumerPostPaymentCashlessBody {
 	token: string;
 }
 
+export interface ReviewDTO {
+	taxonomy?: Record<string, any>;
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	score?: number;
+	comment?: string;
+	reason?: [];
+}
+
+export interface GetReviewOrderItemsRequestDTO {
+	reviews: ReviewDTO[];
+}
+
+export interface PostConsumerShoppingCartBulkBodyRequest {
+	// ids of the shopping carts to get
+	ids: string[];
+}
+
+export interface PostConsumerShoppingCartBulkResponse {
+	// shopping carts
+	shoppingCarts: PostConsumerShoppingCartResponse[];
+}
+
+export interface ConsumerDeleteMealplanBody {
+	// mealplan tenders to delete
+	tenders?: string[];
+}
+
 // GET /consumer/v1/health-check
 
 export type HealthCheckControllerExecuteResponse = {};
@@ -4016,6 +4045,17 @@ export type PutConsumerMealplanBody = ConsumerPutMealplanBody;
 
 export type PutConsumerMealplanResponse = ConsumerPutMealplanResponse;
 
+// DELETE /consumer/mealplan/{mealplanId} - delete mealplan
+
+export interface DeleteMealplanConsumerPath {
+	// Mealplan ID
+	mealplanId: string;
+}
+
+export type DeleteMealplanConsumerBody = ConsumerDeleteMealplanBody;
+
+export type DeleteMealplanConsumerResponse = ConsumerGetMealplanResponse;
+
 // POST /consumer/mealplan/{mealplanId}/verify - Send mealplan verification email
 
 export interface PostMealplanVerifyConsumerPath {
@@ -4152,7 +4192,7 @@ export interface PostConsumerShoppingcartClonePath {
 
 export type PostConsumerShoppingcartCloneBody = PostConsumerShoppingCartCloneBodyRequest;
 
-export type PostConsumerShoppingcartCloneResponse = PostConsumerShoppingCartCloneBodyRequest;
+export type PostConsumerShoppingcartCloneResponse = PostConsumerShoppingCartResponse;
 
 // GET /consumer/location-brand/{id} - Get location brand
 
@@ -4234,3 +4274,21 @@ export type PostConsumerOpenaiChatResponse = OpenAiChatResponse;
 export type PostPaymentValidateMerchantBody$0 = PostPaymentValidateMerchantBody;
 
 export type PostPaymentValidateMerchantResponse$0 = PostPaymentValidateMerchantResponse;
+
+// GET /consumer/review/order/{orderId} - Get reviews for order items
+
+export interface GetConsumerReviewOrderItemsPath {
+	orderId: string;
+}
+
+export interface GetConsumerReviewOrderItemsQuery {
+	cartItemIds: string[];
+}
+
+export type GetConsumerReviewOrderItemsResponse = GetReviewOrderItemsRequestDTO;
+
+// POST /consumer/shoppingcart/bulk - get multiple shopping carts
+
+export type PostConsumerShoppingcartBulkBody = PostConsumerShoppingCartBulkBodyRequest;
+
+export type PostConsumerShoppingcartBulkResponse = PostConsumerShoppingCartBulkResponse;

package/src/interface/location.ts

@@ -578,7 +578,6 @@ export interface PingResponse {
 export interface HealthResponse {
 	status: 'healthy' | 'unhealthy';
 	timestamp: string;
-	version: string;
 	dependencies: HealthDependency[];
 	metadata: HealthMetadata;
 }

package/src/interface/menu.ts

@@ -719,6 +719,7 @@ export interface LocalMenuGroupDTO {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	visibility?: Record<string, any>;
 	id: string;
 	created_at?: string;
 	updated_at?: string;
@@ -2738,6 +2739,7 @@ export interface PostMenuV3LocalMenuGroupBody {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	visibility?: Record<string, any>;
 	vendor_metadata?: VendorMetadataDTO[];
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -2753,6 +2755,7 @@ export interface PostMenuV3LocalMenuGroupResponse {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	visibility?: Record<string, any>;
 	id: string;
 	created_at?: string;
 	updated_at?: string;
@@ -2794,6 +2797,7 @@ export interface GetMenuV3LocalMenuGroupResponse {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	visibility?: Record<string, any>;
 	id: string;
 	created_at?: string;
 	updated_at?: string;
@@ -2825,6 +2829,7 @@ export interface PatchMenuV3LocalMenuGroupBody {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	visibility?: Record<string, any>;
 	id?: string;
 	version?: number;
 	vendor_metadata?: VendorMetadataDTO[];
@@ -2842,6 +2847,7 @@ export interface PatchMenuV3LocalMenuGroupResponse {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	visibility?: Record<string, any>;
 	id: string;
 	created_at?: string;
 	updated_at?: string;
@@ -2879,6 +2885,7 @@ export interface DeleteMenuV3LocalMenuGroupResponse {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	visibility?: Record<string, any>;
 	id: string;
 	created_at?: string;
 	updated_at?: string;
@@ -2935,6 +2942,7 @@ export type PostMenuV3LocalMenuGroupsBody = {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	visibility?: Record<string, any>;
 	vendor_metadata?: VendorMetadataDTO[];
 	permissions?: Record<string, any>;
 	[index: string]: any;

package/src/interface/user.ts

@@ -316,6 +316,27 @@ export interface PingResponse {
 	service?: string;
 }
 
+export interface HealthResponse {
+	status: 'healthy' | 'unhealthy';
+	timestamp: string;
+	version: string;
+	dependencies: HealthDependency[];
+	metadata: HealthMetadata;
+}
+
+export interface HealthDependency {
+	name: string;
+	status: 'healthy' | 'unhealthy';
+	responseTimeMs: number;
+	// Error or status details when unhealthy, null when healthy
+	details?: string;
+}
+
+export interface HealthMetadata {
+	region: string;
+	service: string;
+}
+
 // GET /user/auth - Gets the JWT token for a user
 
 export interface GetUserAuthQuery {
@@ -808,3 +829,9 @@ export interface GetUserProfileRequest extends BaseRequest, RequestQuery<GetUser
 export type GetUserPingResponse = PingResponse;
 
 export interface GetUserPingRequest extends BaseRequest {}
+
+// GET /user/health - User Service health check with dependency validation
+
+export type GetUserHealthResponse = HealthResponse;
+
+export interface GetUserHealthRequest extends BaseRequest {}

package/src/messages/events/AuditEvent.ts

@@ -0,0 +1,52 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface AuditActor {
+	id: string;
+	display_name: string;
+	type: 'human' | 'service' | 'system';
+}
+
+export interface AuditEntityRef {
+	type: string;
+	id: string;
+}
+
+export interface AuditResource {
+	type: string;
+	id: string;
+	name: string;
+}
+
+export interface AuditChanges {
+	// Sparse — only changed fields. For removed items, key present only here.
+	old?: Record<string, any>;
+	// Sparse — only changed fields. For added items, key present only here.
+	new?: Record<string, any>;
+}
+
+export interface AuditEvent {
+	// UUID, producer-assigned. Stable across EventBridge retries — used for deduplication.
+	id: string;
+	type: 'AuditEvent';
+	version: '0.0.1';
+	// ISO 8601 — when the action occurred, not when emitted
+	timestamp: string;
+	traceContext: {
+		traceId: string;
+	};
+	payload: {
+		// e.g. calendar_created, calendar_updated, calendar_deleted
+		action: string;
+		actor: AuditActor;
+		outcome: 'success' | 'failure';
+		// Present when outcome is failure
+		error_message?: string;
+		// Primary entity plus known ancestors (e.g. calendar, brand, location)
+		entity_refs: AuditEntityRef[];
+		resource: AuditResource;
+		changes?: AuditChanges;
+		correlation_id?: string;
+	};
+	// Producer service name (e.g. calendar-service)
+	source: string;
+}

package/src/messages/events/DiscountCreatedEvent.ts

@@ -102,6 +102,7 @@ export interface ItemLevelConfig {
 	globalMenuGroupId?: string;
 	globalMenuGroupName?: string;
 	sectorName?: string;
+	bundlePriority?: number;
 	details: ItemLevelConfigDetails[];
 }
 

package/src/messages/events/DiscountPublishedEvent.ts

@@ -102,6 +102,7 @@ export interface ItemLevelConfig {
 	globalMenuGroupId?: string;
 	globalMenuGroupName?: string;
 	sectorName?: string;
+	bundlePriority?: number;
 	details: ItemLevelConfigDetails[];
 }
 

package/src/messages/events/DiscountUpdatedEvent.ts

@@ -102,6 +102,7 @@ export interface ItemLevelConfig {
 	globalMenuGroupId?: string;
 	globalMenuGroupName?: string;
 	sectorName?: string;
+	bundlePriority?: number;
 	details: ItemLevelConfigDetails[];
 }
 

package/src/messages/events/FrictionlessOrderFailureEvent.ts

@@ -0,0 +1,34 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface FrictionlessOrderFailureEvent {
+	id: string;
+	type: 'FrictionlessOrderFailureEvent';
+	version: '0.0.1';
+	timestamp: string;
+	traceContext: {
+		traceId?: string;
+	};
+	payload: {
+		// The frictionless checkin identifier
+		checkinID: string;
+		// Shopping cart ID of the failed transaction
+		shoppingCartID: string;
+		// Order ID when available
+		orderID?: string;
+		// User ID of the failed transaction
+		userID: string;
+		// User email
+		userEmail: string;
+		// Meal plan ID when payment was mealplan
+		mealPlanID?: string;
+		// Site ID of the transaction
+		siteID: string;
+		// Brand ID of the transaction
+		brandID: string;
+		// Human-readable failure reason e.g. INSUFFICIENT_BALANCE, PAYMENT_DID_NOT_GO_THROUGH, PROCESSING_FAILED
+		failReason: string;
+		// Unpaid balance amount for insufficient balance failures
+		unpaidAmount: number;
+	};
+	source: string;
+}

package/src/messages/events/index.ts

@@ -1,5 +1,7 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
+export { AuditEvent } from './AuditEvent';
+
 export { DiscountCreatedEvent } from './DiscountCreatedEvent';
 
 export { DiscountDeactivatedEvent } from './DiscountDeactivatedEvent';
@@ -16,6 +18,8 @@ export { ExternalRewardRedeemedEvent } from './ExternalRewardRedeemedEvent';
 
 export { FakeEvent } from './FakeEvent';
 
+export { FrictionlessOrderFailureEvent } from './FrictionlessOrderFailureEvent';
+
 export { LocationBrandCreatedEvent } from './LocationBrandCreatedEvent';
 
 export { LocationBrandUpdatedEvent } from './LocationBrandUpdatedEvent';