@compassdigital/sdk.typescript 4.136.0 → 4.139.0

package/src/interface/auth.ts

@@ -6,6 +6,7 @@ import { RequestQuery, BaseRequest } from './util';
 export interface SSOFlowRequestDTO {
 	email: string;
 	realm: string;
+	name: string;
 	clientId: string;
 }
 
@@ -20,10 +21,28 @@ export interface SSOFlowResponseDTO {
 	oidc?: OIDC;
 }
 
-export interface UnauthorizedErrorDTO {
-	message: string;
+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;
+	displayMessage: ErrorDisplayMessage;
+}
+
+export interface Error {
+	// business error code
 	code: number;
-	data: Record<string, any>;
+	// business error description
+	message: string;
+	data: ErrorData;
 }
 
 export interface SSOMapping {

package/src/interface/consumer.ts

@@ -540,6 +540,59 @@ export interface ShoppingcartPromoDetails {
 	order?: ShoppingcartPromoOrder;
 }
 
+export interface ConsumerDiscountStatus {
+	live?: boolean;
+	publishedTo3rdParty?: boolean;
+	readyToPublish?: boolean;
+	active?: boolean;
+}
+
+export interface ConsumerDiscountIs {
+	badgepayPromo?: boolean;
+	mealplanPromo?: boolean;
+	decliningBalancePromo?: boolean;
+	voucherPromo?: boolean;
+}
+
+export interface ConsumerVoucherifyMetaDataDiscount {
+	type: Record<string, any>;
+	amountOff?: number;
+	percentOff?: number;
+}
+
+export interface ConsumerVoucherifyMetaData {
+	id?: string;
+	code?: string;
+	discount?: ConsumerVoucherifyMetaDataDiscount;
+}
+
+export interface ClassMetaProvider {
+	voucherify?: ConsumerVoucherifyMetaData;
+}
+
+export interface ConsumerDiscountMeta {
+	provider: ClassMetaProvider;
+}
+
+export interface ConsumerStackedDiscount {
+	id: string;
+	createdBy: string;
+	updatedBy: string;
+	createdAt: string;
+	updatedAt: string;
+	name: string;
+	status?: ConsumerDiscountStatus;
+	is?: ConsumerDiscountIs;
+	meta?: ConsumerDiscountMeta;
+	applied_amount?: number;
+}
+
+export interface Discounts {
+	applied_amount?: number;
+	app?: string;
+	stacked_discounts?: ConsumerStackedDiscount[];
+}
+
 export interface ShoppingcartPaymentMethodMealplan {
 	id?: string;
 	tender?: string;
@@ -699,6 +752,7 @@ export interface CustomerOrderShoppingcartDTO {
 	sub_total?: ShoppingcartMonetaryValue;
 	promo?: ShoppingcartPromoDetails;
 	discount?: ShoppingcartPromoDetails;
+	discounts?: Discounts;
 	payment_method?: ShoppingcartPaymentMethod;
 	taxes?: ShoppingcartTaxes;
 	total?: ShoppingcartTotal;
@@ -1370,16 +1424,6 @@ export interface GetConsumerMenuItemsResponse {
 	items: ConsumerItem[];
 }
 
-export interface PostConsumerRecommendedRequest {
-	// excluded items
-	excludedItems: string[];
-}
-
-export interface PostConsumerRecommendedResponse {
-	// items
-	items: string[];
-}
-
 export interface ConsumerTimeslot {
 	id?: number;
 	brand_id?: string;
@@ -1723,6 +1767,16 @@ export interface PutConsumerShoppingCartResponse {
 	};
 }
 
+export interface PostConsumerRecommendedRequest {
+	// excluded items
+	excludedItems: string[];
+}
+
+export interface PostConsumerRecommendedResponse {
+	// items
+	items: ConsumerItem[];
+}
+
 export interface PostConsumerShoppingCartBodyRequest {
 	location?: string;
 	menu?: string;
@@ -1835,6 +1889,44 @@ export interface ConsumerVoucher {
 	provider_data?: ShoppingcartFPValidationData;
 }
 
+export interface PostConsumerPromoRedeemRequest {
+	// The promo code to redeem
+	code: string;
+	// The email of the customer
+	email?: string;
+	// The app of the customer
+	app?: string;
+	// The realm of the customer
+	realm?: string;
+	// The location brand of the customer
+	location_brand?: string;
+	shoppingcart?: {
+		id?: string;
+		date_created?: string;
+		items?: ShoppingcartItem[];
+	};
+	totals?: {
+		amount?: number;
+		currency?: string;
+	};
+}
+
+export interface ConsumerRedemption {
+	// The unique identifier of the redemption
+	id?: string;
+	// The date of redemption
+	date?: string;
+	// The result of the redemption
+	result?: boolean;
+	// The promo code that was redeemed
+	code?: string;
+	discount?: ConsumerAppliedDiscount;
+	// The type of redemption
+	type?: string;
+	// The app where the redemption occurred
+	app?: string;
+}
+
 // GET /consumer/v1/health-check
 
 export interface HealthCheckControllerExecuteQuery {
@@ -2057,17 +2149,6 @@ export interface GetConsumerMenuItemsQuery {
 
 export type GetConsumerMenuItemsResponse$0 = GetConsumerMenuItemsResponse;
 
-// POST /consumer/menu/{id}/recommended - Get recommended items
-
-export interface PostConsumerMenuRecommendedItemsPath {
-	// Menu ID as Encoded CDL ID; TODO: mark parameter as required in swagger
-	id: string;
-}
-
-export type PostConsumerMenuRecommendedItemsBody = PostConsumerRecommendedRequest;
-
-export type PostConsumerMenuRecommendedItemsResponse = PostConsumerRecommendedResponse;
-
 // POST /consumer/location/marketplace/timeslots - Get Marketplace timeslots
 
 export interface PostConsumerLocationsMarketplaceTimeslotsQuery {
@@ -2167,6 +2248,17 @@ export type PutConsumerShoppingcartBody = PutConsumerShoppingCartItemsRequest;
 
 export type PutConsumerShoppingcartResponse = PutConsumerShoppingCartResponse;
 
+// POST /consumer/shoppingcart/{id}/recommended - Get recommended items for a station or marketplace cart
+
+export interface PostConsumerShoppingcartRecommendedItemsPath {
+	// Shopping Cart ID as Encoded CDL ID
+	id: string;
+}
+
+export type PostConsumerShoppingcartRecommendedItemsBody = PostConsumerRecommendedRequest;
+
+export type PostConsumerShoppingcartRecommendedItemsResponse = PostConsumerRecommendedResponse;
+
 // POST /consumer/shoppingcart - Create a new shopping cart
 
 export type PostConsumerShoppingcartBody = PostConsumerShoppingCartBodyRequest;
@@ -2178,3 +2270,9 @@ export type PostConsumerShoppingcartResponse = PostConsumerShoppingCartResponse;
 export type PostConsumerPromoValidateBody = PostConsumerPromoValidateRequest;
 
 export type PostConsumerPromoValidateResponse = ConsumerVoucher;
+
+// POST /consumer/promo/redeem - Redeem a promo voucher
+
+export type PostConsumerPromoRedeemBody = PostConsumerPromoRedeemRequest;
+
+export type PostConsumerPromoRedeemResponse = ConsumerRedemption;

package/src/interface/location.ts

@@ -81,6 +81,7 @@ export interface Brand {
 		en?: string;
 		fr?: string;
 	};
+	sequence?: number;
 	timezone?: string;
 	description?: string;
 	// @deprecated
@@ -242,6 +243,7 @@ export interface Location {
 		en?: string;
 		fr?: string;
 	};
+	sequence?: number;
 	search?: string[];
 	app?: string;
 	address?: Address;

package/src/interface/menu.ts

@@ -8368,6 +8368,7 @@ export interface GetMenuV4ItemPath {
 }
 
 export interface GetMenuV4ItemQuery {
+	with_parent?: boolean;
 	// Graphql query string
 	_query?: string;
 }
@@ -8919,6 +8920,7 @@ export interface GetMenuV4ModifierPath {
 }
 
 export interface GetMenuV4ModifierQuery {
+	with_parent?: boolean;
 	// Graphql query string
 	_query?: string;
 }
@@ -9358,6 +9360,7 @@ export interface GetMenuV4ModifierGroupPath {
 }
 
 export interface GetMenuV4ModifierGroupQuery {
+	with_parent?: boolean;
 	// Graphql query string
 	_query?: string;
 }
@@ -9883,6 +9886,89 @@ export interface PostMenuV4UnscheduleMenuRequest extends BaseRequest {
 	body: PostMenuV4UnscheduleMenuBody;
 }
 
+// GET /menu/v4/menu/{id}
+
+export interface GetMenuV4MenuPath {
+	id: string;
+}
+
+export interface GetMenuV4MenuQuery {
+	with_parent?: boolean;
+	// Graphql query string
+	_query?: string;
+}
+
+export interface GetMenuV4MenuResponse {
+	parent?: DraftMenuDTO;
+	children?: DraftMenuDTO[];
+	categories?: DraftCategoryDTO[];
+	stocks?: StockDTO[];
+	station_id?: string;
+	price_level_id?: string;
+	id: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
+	parent_id?: string;
+	name: string;
+	brand_id?: string;
+	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
+	brand?: DraftBrandDTO;
+	changes?: MenuChangeDTO[];
+	vendor_metadata?: VendorMetadataDTO[];
+	permissions?: Record<string, any>;
+	[index: string]: any;
+}
+
+export interface GetMenuV4MenuRequest
+	extends BaseRequest,
+		RequestQuery<GetMenuV4MenuQuery>,
+		GetMenuV4MenuPath {}
+
+// GET /menu/v4/category/{id}
+
+export interface GetMenuV4CategoryPath {
+	id: string;
+}
+
+export interface GetMenuV4CategoryQuery {
+	with_parent?: boolean;
+	// Graphql query string
+	_query?: string;
+}
+
+export interface GetMenuV4CategoryResponse {
+	parent?: DraftCategoryDTO;
+	children?: DraftCategoryDTO[];
+	id: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
+	parent_id?: string;
+	name: string;
+	label?: string;
+	sequence?: number;
+	is_active?: boolean;
+	brand_id?: string;
+	menu_id: string;
+	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
+	menu?: DraftMenuDTO;
+	items?: DraftCategoryToItemRelationshipDTO[];
+	brand?: DraftBrandDTO;
+	changes?: CategoryChangeDTO[];
+	vendor_metadata?: VendorMetadataDTO[];
+	attachments?: FileAttachmentsDTO;
+	permissions?: Record<string, any>;
+	[index: string]: any;
+}
+
+export interface GetMenuV4CategoryRequest
+	extends BaseRequest,
+		RequestQuery<GetMenuV4CategoryQuery>,
+		GetMenuV4CategoryPath {}
+
 // POST /menu/v4/category/{id}/attachment/{name}
 
 export interface PostMenuV4CategoryAttachmentPath {

package/src/interface/order.ts

@@ -199,6 +199,36 @@ export interface Order {
 			code?: string;
 			[index: string]: any;
 		};
+		discounts?: OrderDiscount[];
+		// Discounts for refunds
+		discounts_refund?: {
+			// Client app that applied the discount
+			app?: string;
+			// Date the discount was refunded
+			date?: string;
+			// Date the order was created
+			order_created_at?: string;
+			// Vocuherify Order ID
+			order_id?: string;
+			// Order items
+			order_items?: {
+				// Compassdigital item id
+				source_id?: string;
+				// Quantity of the item
+				quantity?: number;
+				// Price of the item in cents
+				price?: number;
+			}[];
+			// Order total
+			order_total?: number;
+			// Reason for refund
+			reason?: string;
+			// Voucherify parent redemption id for the stacked discounts
+			redemption_id?: string;
+			// true if refund succeeded
+			result?: boolean;
+			[index: string]: any;
+		};
 		// The type of kds that the brand uses
 		type_of_kds?: string;
 		// Indicate whether the order is eligible for cancellation
@@ -390,6 +420,28 @@ export interface ApexCodes {
 	reclaim_code: ApexCodeProperties;
 }
 
+export interface OrderDiscount {
+	// Voucherify redemption id
+	id?: string;
+	date?: string;
+	// true if redemption succeeded
+	result?: boolean;
+	discount?: {
+		// amount_off | percent_off
+		type?: string;
+		amount_off?: number;
+		// Percentage off
+		percent_off?: number;
+	};
+	// redemption
+	type?: string;
+	// Parent redemption id for refunds
+	original_redemption?: string;
+	// Client app that applied the discount
+	app?: string;
+	[index: string]: any;
+}
+
 // POST /order - Create an Order
 
 export interface PostOrderQuery {

package/src/interface/promo.ts

@@ -236,7 +236,7 @@ export interface Voucher {
 }
 
 export interface Redeemable {
-	status: 'APPLICABLE' | 'INAPPLICABLE';
+	status: string;
 	// redeemable
 	id: string;
 	object: 'voucher' | 'promotion_stack' | 'promotion_tier';

package/src/interface/shoppingcart.ts

@@ -269,6 +269,11 @@ export interface ShoppingCartRequest {
 	brand?: string;
 	promo?: PromoDetails;
 	discount?: PromoDetails;
+	discounts?: {
+		stacked_total?: MonetaryValue;
+		stacked_discounts?: Discount[];
+		app?: string;
+	};
 	payment_method?: PaymentMethod;
 	taxes?: Taxes;
 	exemptions?: {

package/src/{events → messages/commands}/SendPushNotificationCommand.ts

@@ -1,10 +1,10 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-export interface SendPushNotificationCommandEvent {
+export interface SendPushNotificationCommand {
 	id: string;
-	type: string;
+	type: 'SendPushNotificationCommand';
 	version: '0.0.1';
-	occurredAt: string;
+	timestamp: string;
 	traceContext: {
 		traceId?: string;
 	};
@@ -18,5 +18,5 @@ export interface SendPushNotificationCommandEvent {
 			data?: Record<string, any>;
 		};
 	};
-	name: 'SendPushNotificationCommand';
+	source: string;
 }

package/src/messages/commands/index.ts

@@ -0,0 +1,3 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export { SendPushNotificationCommand } from './SendPushNotificationCommand';

package/src/messages/events/index.ts

@@ -0,0 +1 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY

package/src/{events/CheckinProcessingFailed.ts → messages/legacy/CheckinProcessingFailedEvent.ts}

@@ -1,7 +1,11 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
+/**
+ * @deprecated
+ * Create a new message type respecting the new standards
+ */
 export interface CheckinProcessingFailedEvent {
-	name: 'CheckinProcessingFailed';
+	name: string;
 	correlationID: string;
 	checkin: {
 		id: string;
@@ -24,5 +28,6 @@ export interface CheckinProcessingFailedEvent {
 		code: string;
 		details?: Record<string, any>;
 	};
+	type: 'CheckinProcessingFailedEvent';
 	version: '0.0.1';
 }

package/src/{events/FrictionlessCheckinExecuted.ts → messages/legacy/FrictionlessCheckinExecutedEvent.ts}

@@ -1,7 +1,11 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
+/**
+ * @deprecated
+ * Create a new message type respecting the new standards
+ */
 export interface FrictionlessCheckinExecutedEvent {
-	name: 'FrictionlessCheckinExecuted';
+	name: string;
 	correlationID: string;
 	checkinID: string;
 	thirdPartyCorrelatedID: string;
@@ -9,5 +13,6 @@ export interface FrictionlessCheckinExecutedEvent {
 	successfully: boolean;
 	tripStartDate: string;
 	tripEndDate: string;
+	type: 'FrictionlessCheckinExecutedEvent';
 	version: '0.0.1';
 }

package/src/{events/FrictionlessShopperCheckedOut.ts → messages/legacy/FrictionlessShopperCheckedOutEvent.ts}

@@ -1,5 +1,9 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
+/**
+ * @deprecated
+ * Create a new message type respecting the new standards
+ */
 export interface PurchasedItem {
 	itemID: string;
 	quantity: number;
@@ -18,7 +22,7 @@ export interface ShoppingTripDetails {
 }
 
 export interface FrictionlessShopperCheckedOutEvent {
-	name: 'FrictionlessShopperCheckedOut';
+	name: string;
 	checkinID: string;
 	correlationID: string;
 	thirdPartyCorrelatedID: string;
@@ -26,5 +30,6 @@ export interface FrictionlessShopperCheckedOutEvent {
 	purchasedItems: PurchasedItem[];
 	metadata: Metadata;
 	shoppingTripDetails: ShoppingTripDetails;
+	type: 'FrictionlessShopperCheckedOutEvent';
 	version: '0.0.1';
 }

package/src/{events/FrictionlessThirdPartyWebhookReceived.ts → messages/legacy/FrictionlessThirdPartyWebhookReceivedEvent.ts}

@@ -1,7 +1,11 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
+/**
+ * @deprecated
+ * Create a new message type respecting the new standards
+ */
 export interface FrictionlessThirdPartyWebhookReceivedEvent {
-	name: 'FrictionlessThirdPartyWebhookReceived';
+	name: string;
 	correlationID: string;
 	webhook: {
 		id: string;
@@ -11,5 +15,6 @@ export interface FrictionlessThirdPartyWebhookReceivedEvent {
 		provider: string;
 		ttl: number;
 	};
+	type: 'FrictionlessThirdPartyWebhookReceivedEvent';
 	version: '0.0.1';
 }

package/src/{events/LegacyBrandCleanupRequested.ts → messages/legacy/LegacyBrandCleanupRequestedEvent.ts}

@@ -1,5 +1,9 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
+/**
+ * @deprecated
+ * Create a new message type respecting the new standards
+ */
 export interface LegacyBrandCleanupRequestedEvent {
 	meta: {
 		// JWT authentication token
@@ -9,6 +13,6 @@ export interface LegacyBrandCleanupRequestedEvent {
 		// Unique identifier of the brand to be cleaned up
 		id: string;
 	};
-	name: 'LegacyBrandCleanupRequested';
+	type: 'LegacyBrandCleanupRequestedEvent';
 	version: '0.0.1';
 }

package/src/{events/LegacyBrandExcelImportRequested.ts → messages/legacy/LegacyBrandExcelImportRequestedEvent.ts}

@@ -1,5 +1,9 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
+/**
+ * @deprecated
+ * Create a new message type respecting the new standards
+ */
 export interface LegacyBrandExcelImportRequestedEvent {
 	meta: {
 		// JWT authentication token
@@ -13,6 +17,6 @@ export interface LegacyBrandExcelImportRequestedEvent {
 		// Email address associated with the import request
 		email: string;
 	};
-	name: 'LegacyBrandExcelImportRequested';
+	type: 'LegacyBrandExcelImportRequestedEvent';
 	version: '0.0.1';
 }

package/src/{events/LegacyDraftBrandDiffGenerateRequested.ts → messages/legacy/LegacyDraftBrandDiffGenerateRequestedEvent.ts}

@@ -1,5 +1,9 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
+/**
+ * @deprecated
+ * Create a new message type respecting the new standards
+ */
 export interface LegacyDraftBrandDiffGenerateRequestedEvent {
 	// Metadata related to the request, including authentication details.
 	meta: {
@@ -11,6 +15,6 @@ export interface LegacyDraftBrandDiffGenerateRequestedEvent {
 		// Unique identifier for the request.
 		id: string;
 	};
-	name: 'LegacyDraftBrandDiffGenerateRequested';
+	type: 'LegacyDraftBrandDiffGenerateRequestedEvent';
 	version: '0.0.1';
 }

package/src/{events/LegacyDraftBrandGlobalDiffsApplyRequested.ts → messages/legacy/LegacyDraftBrandGlobalDiffsApplyRequestedEvent.ts}

@@ -1,5 +1,9 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
+/**
+ * @deprecated
+ * Create a new message type respecting the new standards
+ */
 export interface LegacyDraftBrandGlobalDiffsApplyRequestedEvent {
 	// Metadata related to the request, including authentication details.
 	meta: {
@@ -11,6 +15,6 @@ export interface LegacyDraftBrandGlobalDiffsApplyRequestedEvent {
 		// Unique identifier for the request.
 		id: string;
 	};
-	name: 'LegacyDraftBrandGlobalDiffsApplyRequested';
+	type: 'LegacyDraftBrandGlobalDiffsApplyRequestedEvent';
 	version: '0.0.1';
 }

package/src/{events/LegacyDraftBrandPublishRequested.ts → messages/legacy/LegacyDraftBrandPublishRequestedEvent.ts}

@@ -1,5 +1,9 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
+/**
+ * @deprecated
+ * Create a new message type respecting the new standards
+ */
 export interface LegacyDraftBrandPublishRequestedEvent {
 	// Metadata related to the request, including authentication details.
 	meta: {
@@ -13,6 +17,6 @@ export interface LegacyDraftBrandPublishRequestedEvent {
 		// Unique identifier for the process associated with this request.
 		process_id: string;
 	};
-	name: 'LegacyDraftBrandPublishRequested';
+	type: 'LegacyDraftBrandPublishRequestedEvent';
 	version: '0.0.1';
 }

package/src/{events/LegacyDraftBrandPublished.ts → messages/legacy/LegacyDraftBrandPublishedEvent.ts}

@@ -1,5 +1,9 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
+/**
+ * @deprecated
+ * Create a new message type respecting the new standards
+ */
 export interface LegacyDraftBrandPublishedEvent {
 	// Metadata related to the request, including authentication details.
 	meta: {
@@ -13,6 +17,6 @@ export interface LegacyDraftBrandPublishedEvent {
 		// Unique identifier for the process associated with this request.
 		process_id: string;
 	};
-	name: 'LegacyDraftBrandPublished';
+	type: 'LegacyDraftBrandPublishedEvent';
 	version: '0.0.1';
 }

package/src/{events/LegacyDraftMenuPublishedToV2Menu.ts → messages/legacy/LegacyDraftMenuPublishedToV2MenuEvent.ts}

@@ -1,5 +1,9 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
+/**
+ * @deprecated
+ * Create a new message type respecting the new standards
+ */
 export interface LegacyDraftMenuPublishedToV2MenuEvent {
 	// Metadata related to the request, including authentication details.
 	meta: {
@@ -13,6 +17,6 @@ export interface LegacyDraftMenuPublishedToV2MenuEvent {
 		// Unique identifier for the process associated with this request.
 		process_id: string;
 	};
-	name: 'LegacyDraftMenuPublishedToV2Menu';
+	type: 'LegacyDraftMenuPublishedToV2MenuEvent';
 	version: '0.0.1';
 }