@compassdigital/sdk.typescript 4.156.0 → 4.158.0

package/src/interface/consumer.ts

@@ -235,7 +235,7 @@ export interface OrderRefundItem {
 }
 
 export interface OrderCreditCard {
-	// The credit card type (Amex, Visa, Mastercard, etc...
+	// The credit card type (Amex, Visa, Mastercard, etc...)
 	card_type?: string;
 	// The last 4 digits of the card number
 	last4?: string;
@@ -267,6 +267,7 @@ export interface OrderMealplan {
 	id?: string;
 	// tender
 	tender?: string;
+	// mealplan name
 	name?: string;
 }
 
@@ -553,7 +554,7 @@ export interface ConsumerDiscountIs {
 }
 
 export interface ConsumerVoucherifyMetaDataDiscount {
-	type: Record<string, any>;
+	type: 'AMOUNT_OFF' | 'PERCENT_OFF';
 	amountOff?: number;
 	percentOff?: number;
 }
@@ -582,7 +583,7 @@ export interface ConsumerStackedDiscount {
 	status?: ConsumerDiscountStatus;
 	is?: ConsumerDiscountIs;
 	meta?: ConsumerDiscountMeta;
-	applied_amount?: number;
+	applied_amount: number;
 }
 
 export interface Discounts {
@@ -800,6 +801,139 @@ export interface GetCustomerOrdersResponseDTO {
 	orders: CustomerOrder[];
 }
 
+export interface CreateOrderPayment {
+	token?: string;
+	credit_card?: OrderCreditCard;
+	badge_pay?: OrderCashlessPayment;
+	stipend?: OrderCashlessPayment;
+	voucher?: OrderCashlessPayment;
+	coupon_voucher?: OrderCashlessPayment;
+}
+
+export interface CreateOrderIs {
+	in_progress?: boolean;
+	ready?: boolean;
+}
+
+export interface CreateOrderMeta {
+	// which ui the order was placed on
+	source?: 'web' | 'mobile';
+	// Override for meta.active for testing purposes
+	active_override?: boolean;
+}
+
+export interface CreateOrderDetails {
+	name?: string;
+	contact_number?: string;
+	country_code?: string;
+	order_type?: string;
+	duration?: string;
+	destination?: string;
+	// Pickup or delivery instructions
+	instructions?: string;
+}
+
+export interface PostOrderBodyDto {
+	// The location brand
+	location_brand?: string;
+	// The location
+	location?: string;
+	// The shoppingcart
+	shoppingcart?: string;
+	payment?: CreateOrderPayment;
+	mealplan?: OrderMealplan;
+	// User ID
+	customer?: string;
+	is?: CreateOrderIs;
+	meta?: {
+		[index: string]: any;
+	} & CreateOrderMeta;
+	// Pickup (deprecated)
+	pickup?: string;
+	// Pickup name (deprecated)
+	pickup_name?: string;
+	// Requested date
+	requested_date?: string;
+	details?: CreateOrderDetails;
+}
+
+export interface PlacedOrderMeta {
+	// Check-in UUID for frictionless orders
+	checkin_uuid?: string;
+	// which ui the order was placed on
+	source?: 'web' | 'mobile';
+	transaction?: OrderTransaction;
+	shoppingcart?: OrderMetaShoppingcart;
+	// Indicate whether the order is active or inactive
+	active?: boolean;
+	// Override for meta.active for testing purposes
+	active_override?: boolean;
+	delivery?: OrderDelivery;
+	discount?: OrderDiscount;
+	// The type of kds that the brand uses
+	type_of_kds?: string;
+	// Indicate whether the order is eligible for cancellation
+	cancel_eligible?: boolean;
+	refunds?: OrderRefundTransaction[];
+}
+
+export interface PostOrderResponseDto {
+	// Order ID
+	id?: string;
+	// Brand/location ID
+	location_brand?: string;
+	// Location ID
+	location?: string;
+	// Shopping cart ID
+	shoppingcart?: string;
+	// Payment details
+	payment?: Record<string, any>;
+	mealplan?: OrderMealplan;
+	meal_swipes?: OrderMealSwipes;
+	meal_exchange?: OrderMealplan;
+	// User ID
+	customer?: string;
+	is?: OrderIs;
+	date?: OrderDate;
+	// Pickup (deprecated)
+	pickup?: string;
+	// Pickup name (deprecated)
+	pickup_name?: string;
+	// Pickup ID (deprecated)
+	pickup_id?: string;
+	// Requested date
+	requested_date?: string;
+	details?: OrderDetails;
+	meta?: {
+		[index: string]: any;
+	} & PlacedOrderMeta;
+	issue?: OrderIssue;
+	// Past issues
+	past_issues?: OrderIssue[];
+	// Delivery user
+	runner?: string;
+	// Reorder eligibility
+	reorder_eligibility?:
+		| 'eligible'
+		| 'order_type_ineligible'
+		| 'location_ineligible'
+		| 'active_order'
+		| 'old_order'
+		| 'marketplace_order'
+		| 'duplicate_order'
+		| 'brand_unavailable'
+		| 'menu_unavailable'
+		| 'items_unavailable'
+		| 'refunded_order'
+		| 'modifiers_unavailable'
+		| 'modified_items'
+		| 'cancelled_order';
+	// Refunds
+	refunds?: OrderRefundItem[];
+	// Latest refunds
+	latest_refunds?: OrderRefundItem[];
+}
+
 export interface PostReviewOrderItemRequest {
 	// rating score
 	score: number;
@@ -1987,6 +2121,12 @@ export interface GetCustomerOrdersQuery {
 
 export type GetCustomerOrdersResponse = GetCustomerOrdersResponseDTO;
 
+// POST /consumer/order - Create a new order
+
+export type PostConsumerOrderBody = PostOrderBodyDto;
+
+export type PostConsumerOrderResponse = PostOrderResponseDto;
+
 // POST /consumer/review/order-items - Submit reviews for order items
 
 export type PostReviewOrderItemsBody = PostReviewOrderItemsRequestDTO;

package/src/interface/discount.ts

@@ -14,8 +14,6 @@ export interface DiscountStatus {
 export interface DiscountIs {
 	badgepayPromo?: boolean;
 	mealplanPromo?: boolean;
-	decliningBalancePromo?: boolean;
-	voucherPromo?: boolean;
 }
 
 export interface VoucherifyMetaDataDiscount {
@@ -45,7 +43,8 @@ export interface GetDiscountResponseDTO {
 	createdBy: string;
 	// user id of most recent update
 	updatedBy: string;
-	sites: string[];
+	sites?: string[];
+	brands?: string[];
 	createdAt: string;
 	updatedAt: string;
 	name: string;
@@ -110,7 +109,8 @@ export interface DiscountWithEntities {
 	status: DiscountStatus;
 	is?: DiscountIs;
 	meta?: DiscountMeta;
-	sites: string[];
+	sites?: string[];
+	brands?: string[];
 }
 
 export interface GetAllDiscountsResponseDTO {

package/src/messages/commands/SendPushNotificationCommand.ts

@@ -10,7 +10,7 @@ export interface SendPushNotificationCommand {
 	};
 	payload: {
 		notification?: {
-			targets: Record<string, any>[];
+			targets: string[];
 			createdAt: string;
 			updatedAt: string;
 			title: string;