@compassdigital/sdk.typescript 4.160.0 → 4.163.0

package/src/interface/consumer.ts

@@ -77,6 +77,7 @@ export interface ErrorData {
 	// http status text
 	statusText: string;
 	timestamp: string;
+	// user friendly error message
 	displayMessage: ErrorDisplayMessage;
 }
 
@@ -85,6 +86,7 @@ export interface Error {
 	code: number;
 	// business error description
 	message: string;
+	// additional error data
 	data: ErrorData;
 }
 
@@ -94,12 +96,14 @@ export interface OrderTotals {
 }
 
 export interface OrderTransaction {
+	// used in mx orders - cart totals in dollars and meal exchange value (meals)
 	mx_totals?: OrderTotals;
 	// the amount remaining on the transaction after refund - remaining amount available for refund
 	transaction_remainder_amount?: number;
 }
 
 export interface OrderMetaShoppingcart {
+	// Total of first cart on order. Carts can change after refunds, so this is original value
 	original_total?: OrderTotals;
 	total?: OrderTotals;
 }
@@ -150,13 +154,17 @@ export interface OrderMeta {
 	checkin_uuid?: string;
 	// which ui the order was placed on
 	source?: 'web' | 'mobile';
+	// details pertaining to the amount charged on the order
 	transaction?: OrderTransaction;
+	// Shoppingcart details
 	shoppingcart?: OrderMetaShoppingcart;
 	// Indicate whether the order is active or inactive
 	active?: boolean;
 	// Override for meta.active for testing purposes
 	active_override?: boolean;
+	// Delivery details
 	delivery?: OrderDelivery;
+	// Discount details
 	discount?: OrderDiscount;
 	// The type of kds that the brand uses
 	type_of_kds?: string;
@@ -229,6 +237,7 @@ export interface OrderRefundItem {
 	_index?: string;
 	// Quantity of the item
 	quantity?: number;
+	// Price of the item
 	price?: OrderMonetaryValue;
 	// Reason for refund
 	reason?: string;
@@ -316,7 +325,9 @@ export interface OrderItemWithIssue {
 	id: string;
 	// index
 	_index: string;
+	// Subtotal of the item including all options
 	_subtotal?: OrderMonetaryValue;
+	// Promo applied to this item
 	_promo?: OrderMonetaryValue;
 	reason?: string;
 	quantity?: number;
@@ -337,9 +348,8 @@ export interface OrderIssue {
 	items?: OrderItemWithIssue[];
 	// Optional additional explanation for issue: 5,10,15 for late issues, SOLD_OUT, MODIFICATION, DIETARY_RESTRICTION for see kitchen issues
 	reason?: string;
-	meta?: {
-		[index: string]: any;
-	} & OrderIssueMeta;
+	// Issue Meta
+	meta?: OrderIssueMeta;
 	type?: string;
 }
 
@@ -412,9 +422,7 @@ export interface ShoppingcartItemModifierIs {
 export interface ShoppingcartItemModifier {
 	// index
 	_index?: string;
-	meta?: {
-		[index: string]: any;
-	} & ShoppingcartItemModifierMeta;
+	meta?: ShoppingcartItemModifierMeta;
 	amount_off_exclusions?: string[];
 	id?: string;
 	price?: ShoppingcartMonetaryValue;
@@ -424,9 +432,7 @@ export interface ShoppingcartItemModifier {
 }
 
 export interface ShoppingcartItemModifierGroup {
-	meta?: {
-		[index: string]: any;
-	} & ShoppingcartItemModifierGroupMeta;
+	meta?: ShoppingcartItemModifierGroupMeta;
 	id?: string;
 	label?: ShoppingcartLabel;
 	items?: ShoppingcartItemModifier[];
@@ -467,13 +473,15 @@ export interface ShoppingcartItem {
 	id: string;
 	// index based on cdl id or stringified timestamp
 	_index?: string;
+	// Final item price after LTO/Bundle/BOGO etc is applied on the item.
 	sale_price?: ShoppingcartSalePrice;
+	// Subtotal of the item including all options
 	_subtotal?: ShoppingcartMonetaryValue;
+	// Promo applied to this item
 	_promo?: ShoppingcartMonetaryValue;
+	// Discount applied to this item
 	_discount?: ShoppingcartMonetaryValue;
-	meta?: {
-		[index: string]: any;
-	} & ShoppingcartItemMeta;
+	meta?: ShoppingcartItemMeta;
 	// Details about discount like BOGO, LTO, Bundle etc.
 	item_discount?: Record<string, any>;
 	// user specified instructions for the item
@@ -761,9 +769,7 @@ export interface CustomerOrderShoppingcartDTO {
 }
 
 export interface CustomerOrder {
-	meta?: {
-		[index: string]: any;
-	} & OrderMeta;
+	meta?: OrderMeta;
 	id?: string;
 	reorder_eligibility?:
 		| 'eligible'
@@ -839,20 +845,23 @@ export interface PostOrderBodyDto {
 	location?: string;
 	// The shoppingcart
 	shoppingcart?: string;
+	// Payment details
 	payment?: CreateOrderPayment;
+	// Meal plan
 	mealplan?: OrderMealplan;
 	// User ID
 	customer?: string;
+	// Order status flags
 	is?: CreateOrderIs;
-	meta?: {
-		[index: string]: any;
-	} & CreateOrderMeta;
+	// Meta information
+	meta?: CreateOrderMeta;
 	// Pickup (deprecated)
 	pickup?: string;
 	// Pickup name (deprecated)
 	pickup_name?: string;
 	// Requested date
 	requested_date?: string;
+	// Order details
 	details?: CreateOrderDetails;
 }
 
@@ -861,13 +870,17 @@ export interface PlacedOrderMeta {
 	checkin_uuid?: string;
 	// which ui the order was placed on
 	source?: 'web' | 'mobile';
+	// details pertaining to the amount charged on the order
 	transaction?: OrderTransaction;
+	// Shoppingcart details
 	shoppingcart?: OrderMetaShoppingcart;
 	// Indicate whether the order is active or inactive
 	active?: boolean;
 	// Override for meta.active for testing purposes
 	active_override?: boolean;
+	// Delivery details
 	delivery?: OrderDelivery;
+	// Discount details
 	discount?: OrderDiscount;
 	// The type of kds that the brand uses
 	type_of_kds?: string;
@@ -885,13 +898,19 @@ export interface PostOrderResponseDto {
 	location?: string;
 	// Shopping cart ID
 	shoppingcart?: string;
+	// Payment details
 	payment?: OrderPayment;
+	// Meal plan
 	mealplan?: OrderMealplan;
+	// Meal swipes
 	meal_swipes?: OrderMealSwipes;
+	// Meal exchange
 	meal_exchange?: OrderMealplan;
 	// User ID
 	customer?: string;
+	// Order status flags
 	is?: OrderIs;
+	// Order date info
 	date?: OrderDate;
 	// Pickup (deprecated)
 	pickup?: string;
@@ -901,10 +920,11 @@ export interface PostOrderResponseDto {
 	pickup_id?: string;
 	// Requested date
 	requested_date?: string;
+	// Order details
 	details?: OrderDetails;
-	meta?: {
-		[index: string]: any;
-	} & PlacedOrderMeta;
+	// Order meta info
+	meta?: PlacedOrderMeta;
+	// Issue
 	issue?: OrderIssue;
 	// Past issues
 	past_issues?: OrderIssue[];
@@ -989,9 +1009,7 @@ export interface ConsumerAnnouncement {
 }
 
 export interface HomePageOrder {
-	meta?: {
-		[index: string]: any;
-	} & OrderMeta;
+	meta?: OrderMeta;
 	id?: string;
 	reorder_eligibility?:
 		| 'eligible'
@@ -1282,12 +1300,15 @@ export interface ConsumerGroup {
 }
 
 export interface HomePageResponse {
+	// valid diverse greeting messages
 	greetingMessage: DiverseGreetingMessages;
+	// valid hero images
 	heroImages: HeroImage;
 	// active announcements
 	announcements?: ConsumerAnnouncement[];
 	// array of orders
 	orders?: HomePageOrder[];
+	// location object for the site
 	location?: ConsumerGroup;
 }
 
@@ -1738,9 +1759,8 @@ export interface PutConsumerUserResponse {
 	realm?: string;
 	// The gender of the user
 	gender?: Record<string, any>;
-	meta?: {
-		[index: string]: any;
-	} & ConsumerUserMeta;
+	// The meta of the user
+	meta?: ConsumerUserMeta;
 	is?: {
 		disabled?: boolean;
 		locked_out?: boolean;
@@ -1749,6 +1769,7 @@ export interface PutConsumerUserResponse {
 		deleted?: boolean;
 		placeholder?: boolean;
 	};
+	// The permissions of the user
 	permissions?: ConsumerScopes;
 	// The location group of the user
 	location_group?: string;
@@ -1781,9 +1802,8 @@ export interface GetConsumerUserResponse {
 	realm?: string;
 	// The gender of the user
 	gender?: Record<string, any>;
-	meta?: {
-		[index: string]: any;
-	} & ConsumerUserMeta;
+	// The meta of the user
+	meta?: ConsumerUserMeta;
 	is?: {
 		disabled?: boolean;
 		locked_out?: boolean;
@@ -1792,6 +1812,7 @@ export interface GetConsumerUserResponse {
 		deleted?: boolean;
 		placeholder?: boolean;
 	};
+	// The permissions of the user
 	permissions?: ConsumerScopes;
 	// The location group of the user
 	location_group?: string;
@@ -1929,6 +1950,7 @@ export interface PostConsumerRecommendedRequest {
 }
 
 export interface ConsumerRecommendedItem {
+	// item
 	item: ConsumerItem;
 	station_name?: string;
 	menu_id?: string;
@@ -2072,6 +2094,7 @@ export interface ConsumerRedemption {
 	result?: boolean;
 	// The promo code that was redeemed
 	code?: string;
+	// The discount applied
 	discount?: ConsumerAppliedDiscount;
 	// The type of redemption
 	type?: string;
@@ -2435,3 +2458,11 @@ export type PostConsumerPromoValidateResponse = ConsumerVoucher;
 export type PostConsumerPromoRedeemBody = PostConsumerPromoRedeemRequest;
 
 export type PostConsumerPromoRedeemResponse = ConsumerRedemption;
+
+// PUT /consumer/user/mealplan/{locationId} - Link mealplan to user
+
+export interface PutConsumerUserMealplanPath {
+	locationId: string;
+}
+
+export type PutConsumerUserMealplanResponse = {};

package/src/interface/discount.ts

@@ -29,10 +29,12 @@ export interface VoucherifyMetaData {
 }
 
 export interface MetaProvider {
+	// Voucherify metadata
 	voucherify?: VoucherifyMetaData;
 }
 
 export interface DiscountMeta {
+	// discount 3rd party provider metadata
 	provider: MetaProvider;
 }
 
@@ -66,6 +68,7 @@ export interface ErrorData {
 	// http status text
 	statusText: string;
 	timestamp: string;
+	// user friendly error message
 	displayMessage: ErrorDisplayMessage;
 }
 
@@ -74,6 +77,7 @@ export interface Error {
 	code: number;
 	// business error description
 	message: string;
+	// additional error data
 	data: ErrorData;
 }
 

package/src/interface/frictionless.ts

@@ -23,6 +23,7 @@ export interface ErrorData {
 	// http status text
 	statusText: string;
 	timestamp: string;
+	// user friendly error message
 	displayMessage: ErrorDisplayMessage;
 }
 
@@ -31,6 +32,7 @@ export interface Error {
 	code: number;
 	// business error description
 	message: string;
+	// additional error data
 	data: ErrorData;
 }
 
@@ -49,7 +51,9 @@ export interface CreditCardDTO {
 }
 
 export interface PaymentMethodDTO {
+	// The mealplan information
 	mealplan?: MealplanDTO;
+	// The credit card information
 	creditCard?: CreditCardDTO;
 	// Token used for identify the payment method
 	token: string;

package/src/interface/menu.ts

@@ -4451,6 +4451,7 @@ export interface PostMenuV3DraftMenuDuplicatePath {
 
 export interface PostMenuV3DraftMenuDuplicateBody {
 	name?: string;
+	translation?: NameTranslation;
 	[index: string]: any;
 }
 
@@ -4841,6 +4842,7 @@ export interface PostMenuV3DraftCategoryDuplicateBody {
 	sequence?: number;
 	is_active?: boolean;
 	menu_id?: string;
+	translation?: NameTranslation;
 	[index: string]: any;
 }
 
@@ -8367,6 +8369,28 @@ export interface PostMenuV4BrandMenuDuplicateRequest
 	body: PostMenuV4BrandMenuDuplicateBody;
 }
 
+// GET /menu/v4/brand/{id}/export
+
+export interface GetMenuV4BrandExportPath {
+	id: string;
+}
+
+export interface GetMenuV4BrandExportQuery {
+	format?: 'xlsx';
+	// Graphql query string
+	_query?: string;
+}
+
+export interface GetMenuV4BrandExportResponse {
+	s3_link: string;
+	[index: string]: any;
+}
+
+export interface GetMenuV4BrandExportRequest
+	extends BaseRequest,
+		RequestQuery<GetMenuV4BrandExportQuery>,
+		GetMenuV4BrandExportPath {}
+
 // POST /menu/v4/item/{id}/attachment/{name}
 
 export interface PostMenuV4ItemAttachmentPath {

package/src/interface/order.ts

@@ -378,9 +378,9 @@ export interface Orders {
 	};
 }
 
-export interface ItemsWithIssue extends OrderedItem {
+export type ItemsWithIssue = OrderedItem & {
 	reason?: string;
-}
+};
 
 export interface ActionResponse {
 	success?: boolean;

package/src/interface/review.ts

@@ -30,6 +30,7 @@ export interface ErrorData {
 	// http status text
 	statusText: string;
 	timestamp: string;
+	// user friendly error message
 	displayMessage: ErrorDisplayMessage;
 }
 
@@ -38,6 +39,7 @@ export interface Error {
 	code: number;
 	// business error description
 	message: string;
+	// additional error data
 	data: ErrorData;
 }
 

package/src/interface/tax.ts

@@ -45,11 +45,13 @@ export interface TaxRequestDTO {
 	id: string;
 	// the app to associate the transaction with
 	appName: string;
+	// the order fulfillment type
 	transactionType: TransactionType;
 	// numeric value of service fee
 	serviceFee?: number;
 	// numeric value of delivery fee
 	deliveryFee?: number;
+	// location data of the transaction
 	locationData: TaxLocationData;
 	// items to calculate tax on
 	items: TaxItemDTO[];
@@ -75,6 +77,7 @@ export interface TaxResponseDTO {
 	amount: number;
 	// the total tax rate applied to the items to determine the total tax of the transaction
 	rate: number;
+	// tax breakdown containing amount for state/province and total taxable amount
 	breakdown: TaxBreakdownDTO;
 	// the name of the tax provider
 	provider: string;
@@ -93,6 +96,7 @@ export interface ErrorData {
 	// http status text
 	statusText: string;
 	timestamp: string;
+	// user friendly error message
 	displayMessage: ErrorDisplayMessage;
 }
 
@@ -101,6 +105,7 @@ export interface Error {
 	code: number;
 	// business error description
 	message: string;
+	// additional error data
 	data: ErrorData;
 }
 

package/src/interface/timeslots.ts

@@ -28,6 +28,7 @@ export interface ErrorData {
 	// http status text
 	statusText: string;
 	timestamp: string;
+	// user friendly error message
 	displayMessage: ErrorDisplayMessage;
 }
 
@@ -36,6 +37,7 @@ export interface Error {
 	code: number;
 	// business error description
 	message: string;
+	// additional error data
 	data: ErrorData;
 }
 

package/src/interface/user.ts

@@ -19,6 +19,7 @@ export interface User {
 	date?: {
 		created?: string;
 		modified?: string;
+		last_accessed?: string;
 	};
 	birthday?: string;
 	password?: string;
@@ -47,6 +48,7 @@ export interface User {
 	// User location group
 	location_group?: string;
 	ssoId?: string;
+	last_accessed?: string;
 }
 
 export interface CashlessLog {

package/src/messages/legacy/CheckinProcessingFailedEvent.ts

@@ -5,7 +5,7 @@
  * Create a new message type respecting the new standards
  */
 export interface CheckinProcessingFailedEvent {
-	name: string;
+	name: 'checkin-processing-failed-event';
 	correlationID: string;
 	checkin: {
 		id: string;

package/src/messages/legacy/FrictionlessCheckinExecutedEvent.ts

@@ -5,7 +5,7 @@
  * Create a new message type respecting the new standards
  */
 export interface FrictionlessCheckinExecutedEvent {
-	name: string;
+	name: 'frictionless-checkin-executed-event';
 	correlationID: string;
 	checkinID: string;
 	thirdPartyCorrelatedID: string;

package/src/messages/legacy/FrictionlessThirdPartyWebhookReceivedEvent.ts

@@ -5,7 +5,7 @@
  * Create a new message type respecting the new standards
  */
 export interface FrictionlessThirdPartyWebhookReceivedEvent {
-	name: string;
+	name: 'frictionless-third-party-webhook-received-event';
 	correlationID: string;
 	webhook: {
 		id: string;

package/src/messages/legacy/ReprocessCheckinCommandArrivedEvent.ts

@@ -5,7 +5,7 @@
  * Create a new message type respecting the new standards
  */
 export interface ReprocessCheckinCommandArrivedEvent {
-	name: string;
+	name: 'reprocess-checkin-command-arrived-event';
 	checkinID: string;
 	correlationID: string;
 	type: 'ReprocessCheckinCommandArrivedEvent';

package/src/messages/legacy/UpdateCheckInPaymentRequiredEvent.ts

@@ -5,7 +5,7 @@
  * Create a new message type respecting the new standards
  */
 export interface UpdateCheckInPaymentRequiredEvent {
-	name: string;
+	name: 'update-checkin-payment-required-event';
 	correlationID: string;
 	checkin: {
 		id: string;