@compassdigital/sdk.typescript 4.208.0 → 4.210.0

package/src/interface/forecasting.ts

@@ -0,0 +1,148 @@
+/* eslint-disable */
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+import { RequestQuery, BaseRequest } from './util';
+
+export interface CreateProductionSheetDto {
+	// Site ID the production sheet is for
+	siteId: string;
+	// Start date of which scheduled menu items are being forecasted for
+	fromDate: string;
+	// End date of which scheduled menu items are being forecasted for
+	toDate: string;
+	// Response ID provided by Luna for session continuity
+	responseId?: string;
+}
+
+export interface ProductionSheetItemForecastDiffDto {
+	// Item name
+	item_name: string;
+	// Item posid
+	pos_id: string;
+	// Name of menu item belongs to
+	menu_name: string;
+	// ID of menu item belongs to
+	menu_id: string;
+	// Name of brand item belongs to
+	brand_name: string;
+	// ID of brand item belongs to
+	brand_id: string;
+	// Original forecasted amount from Luna
+	forecasted_amount: number;
+	// Manually updated forecast amount
+	updated_forecast_amount: number;
+	// Previous week's actual sale amount
+	last_week_amount: number;
+	// Manually updated 'on-hand' amount of the item
+	on_hand: number;
+}
+
+export interface ItemDiffOnSaveRequestDto {
+	// Site ID
+	siteId: string;
+	// Date of the request
+	date: string;
+	// Date of the production sheet
+	production_sheet_date: string;
+	// Username of user who saved production sheet
+	username: string;
+	// Array of items with forecast diffs
+	items: ProductionSheetItemForecastDiffDto[];
+}
+
+export interface ItemForecastDiffResponse {
+	// Success message from Luna API
+	data: string;
+}
+
+export interface ChatItemDto {
+	// Item's display name
+	name: string;
+	// Item's POSID
+	posid: string;
+}
+
+export interface ChatMessageDto {
+	// Timestamp of chat request
+	created_at: string;
+	// User message for chat endpoint
+	message: string;
+	// Site ID associated with chat request
+	site_id: string;
+	// Username of the user sending the message
+	username: string;
+	// Production sheet date for context
+	production_sheet_date?: string;
+	// Feedback rating for Luna messages
+	feedback?: 'positive' | 'negative';
+	// Item the user wants context on
+	item: ChatItemDto;
+}
+
+export interface ChatFeedbackDto {
+	// Site ID associated with chat request
+	site_id: string;
+	// Username of the user sending the message
+	username: string;
+	// Feedback rating for Luna messages
+	feedback: 'positive' | 'negative';
+	// User message for chat endpoint
+	message: string;
+	// Timestamp of chat request
+	created_at: string;
+}
+
+// POST /forecasting/production-sheet - Create a new Production Sheet
+
+export type ProductionSheetControllerCreateSheetBody = CreateProductionSheetDto;
+
+export type ProductionSheetControllerCreateSheetResponse = {};
+
+// GET /forecasting/scheduled-menu-data - Get scheduled menu data for a site for a given date
+
+export interface ProductionSheetControllerGetScheduledMenuDataQuery {
+	siteId: string;
+	date: string;
+	// Graphql query string
+	_query?: string;
+}
+
+export type ProductionSheetControllerGetScheduledMenuDataResponse = {};
+
+// POST /forecasting/item-forecast-diff - Send initial and updated forecast values for any items that had their forecast values manually updated in the centric UI prior to hitting 'Print and Save'
+
+export type ProductionSheetControllerSaveItemForecastDifferentialBody = ItemDiffOnSaveRequestDto;
+
+export type ProductionSheetControllerSaveItemForecastDifferentialResponse =
+	ItemForecastDiffResponse;
+
+// POST /forecasting/chat - Relay a user chat message to Luna
+
+export type ProductionSheetControllerSendChatMessageBody = ChatMessageDto;
+
+export type ProductionSheetControllerSendChatMessageResponse = {};
+
+// POST /forecasting/chat-feedback - Send user feedback for Luna chat messages
+
+export type ProductionSheetControllerSendChatFeedbackBody = ChatFeedbackDto;
+
+export type ProductionSheetControllerSendChatFeedbackResponse = {};
+
+// GET /forecasting/forecast-metadata - Get forecast meta data from Luna
+
+export interface ProductionSheetControllerGetForecastMetaDataQuery {
+	site_id: string;
+	// Graphql query string
+	_query?: string;
+}
+
+export type ProductionSheetControllerGetForecastMetaDataResponse = {};
+
+// GET /forecasting/status
+
+export interface ProductionSheetControllerServiceStatusQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type ProductionSheetControllerServiceStatusResponse = {};

package/src/interface/order.ts

@@ -4,6 +4,8 @@
 import { RequestQuery, BaseRequest } from './util';
 
 export interface CreateOrder {
+	// For mealplan orders, the ID of the mealplan
+	id?: string;
 	location_brand?: string;
 	location?: string;
 	shoppingcart?: string;
@@ -45,6 +47,32 @@ export interface CreateOrder {
 	};
 }
 
+export interface CreatePOSOrder {
+	location_brand?: string;
+	location?: string;
+	shoppingcart?: string;
+	payment?: {
+		pos?: POSPayment;
+	};
+	customer?: string;
+	is?: {
+		in_progress?: boolean;
+		ready?: boolean;
+	};
+	meta?: {
+		// which ui the order was placed on
+		source?: 'pos';
+		// Override for meta.active for testing purposes
+		active_override?: boolean;
+		[index: string]: any;
+	};
+	requested_date?: string;
+	details?: {
+		name?: string;
+		order_type?: string;
+	};
+}
+
 export interface Error {
 	error?: string;
 	code?: number;
@@ -79,6 +107,7 @@ export interface Order {
 		stipend?: CashlessPayment;
 		voucher?: CashlessPayment;
 		coupon_voucher?: CashlessPayment;
+		pos?: POSPayment;
 	};
 	mealplan?: {
 		id?: string;
@@ -157,7 +186,7 @@ export interface Order {
 		checkin_uuid?: string;
 		refunds?: RefundTransaction[];
 		// which ui the order was placed on
-		source?: 'web' | 'mobile';
+		source?: 'web' | 'mobile' | 'pos';
 		// details pertaining to the amount charged on the order
 		transaction?: {
 			// used in mx orders - cart totals in dollars and meal exchange value (meals)
@@ -325,6 +354,12 @@ export interface MealPlan {
 	name?: string;
 }
 
+export interface POSPayment {
+	type?: string;
+	// FreedomPay Transaction details
+	transaction?: Record<string, any>;
+}
+
 export interface OrderIssue {
 	// Type of issue
 	type?: string;
@@ -461,6 +496,21 @@ export interface PostOrderRequest extends BaseRequest, RequestQuery<PostOrderQue
 	body: PostOrderBody;
 }
 
+// POST /pos-order - Place a POS order
+
+export interface PostPosOrderQuery {
+	// The language of the user ex en, fr
+	lang?: string;
+}
+
+export type PostPosOrderBody = CreatePOSOrder;
+
+export type PostPosOrderResponse = Order;
+
+export interface PostPosOrderRequest extends BaseRequest, RequestQuery<PostPosOrderQuery> {
+	body: PostPosOrderBody;
+}
+
 // GET /order/{id} - Get an individual order
 
 export interface GetOrderPath {

package/src/interface/search.ts

@@ -138,6 +138,53 @@ export interface GetUserPaginatedResult {
 	results: GetUserDto[];
 }
 
+export interface DiscountStatus {
+	live?: boolean;
+	publishedTo3rdParty?: boolean;
+	readyToPublish?: boolean;
+	active?: boolean;
+	syncedWith3rdParty?: boolean;
+}
+
+export interface DiscountIs {
+	badgepayPromo?: boolean;
+	mealplanPromo?: boolean;
+}
+
+export interface VoucherifyMetaDataDiscount {
+	type: string;
+	amountOff?: number;
+	percentOff?: number;
+}
+
+export interface VoucherifyMetaData {
+	id?: string;
+	code?: string;
+	discount?: VoucherifyMetaDataDiscount;
+}
+
+export interface MetaProvider {
+	voucherify?: VoucherifyMetaData;
+}
+
+export interface DiscountMeta {
+	provider: MetaProvider;
+}
+
+export interface GetSearchDiscountResponseDTO {
+	id: string;
+	createdBy: string;
+	updatedBy?: string;
+	createdAt: string;
+	updatedAt: string;
+	name: string;
+	status?: DiscountStatus;
+	is?: DiscountIs;
+	meta?: DiscountMeta;
+	sites: string[];
+	brands: string[];
+}
+
 // GET /search/order
 
 export interface GetSearchOrderQuery {
@@ -233,9 +280,22 @@ export interface GetSearchUserQuery {
 	// Filter entities with names or roles containing this value
 	filter?: string;
 	// Filter entities by realm
-	realm?: string;
+	realm?: string[];
 	// Graphql query string
 	_query?: string;
 }
 
 export type GetSearchUserResponse = GetUserPaginatedResult;
+
+// GET /search/discounts/{id} - Get discounts from search
+
+export interface GetSearchDiscountsPath {
+	id: string;
+}
+
+export interface GetSearchDiscountsQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetSearchDiscountsResponse = GetSearchDiscountResponseDTO;