@compassdigital/sdk.typescript 4.207.0 → 4.209.0

package/src/index.ts

@@ -41,6 +41,9 @@ import {
 	PostOrderQuery,
 	PostOrderBody,
 	PostOrderResponse,
+	PostPosOrderQuery,
+	PostPosOrderBody,
+	PostPosOrderResponse,
 	GetOrderQuery,
 	GetOrderResponse,
 	PutOrderResponse,
@@ -1283,6 +1286,8 @@ import {
 	GetSearchLocationResponse,
 	GetSearchUserQuery,
 	GetSearchUserResponse,
+	GetSearchDiscountsQuery,
+	GetSearchDiscountsResponse,
 } from './interface/search';
 
 import {
@@ -1345,6 +1350,23 @@ import {
 	PostTimeslotsBrandIncrementResponse,
 } from './interface/timeslots';
 
+import {
+	ProductionSheetControllerCreateSheetBody,
+	ProductionSheetControllerCreateSheetResponse,
+	ProductionSheetControllerGetScheduledMenuDataQuery,
+	ProductionSheetControllerGetScheduledMenuDataResponse,
+	ProductionSheetControllerSaveItemForecastDifferentialBody,
+	ProductionSheetControllerSaveItemForecastDifferentialResponse,
+	ProductionSheetControllerSendChatMessageBody,
+	ProductionSheetControllerSendChatMessageResponse,
+	ProductionSheetControllerSendChatFeedbackBody,
+	ProductionSheetControllerSendChatFeedbackResponse,
+	ProductionSheetControllerGetForecastMetaDataQuery,
+	ProductionSheetControllerGetForecastMetaDataResponse,
+	ProductionSheetControllerServiceStatusQuery,
+	ProductionSheetControllerServiceStatusResponse,
+} from './interface/forecasting';
+
 import { BaseServiceClient, RequestOptions, ResponsePromise } from './base';
 export * from './base';
 
@@ -1664,6 +1686,21 @@ export class ServiceClient extends BaseServiceClient {
 		return this.request('order', '/order', 'POST', `/order`, body, options);
 	}
 
+	/**
+	 * POST /pos-order - Place a POS order
+	 *
+	 * @param body - Order object that needs to be created
+	 * @param options - additional request options
+	 */
+	post_pos_order(
+		body: PostPosOrderBody,
+		options?: {
+			query?: PostPosOrderQuery;
+		} & RequestOptions,
+	): ResponsePromise<PostPosOrderResponse> {
+		return this.request('order', '/pos-order', 'POST', `/pos-order`, body, options);
+	}
+
 	/**
 	 * GET /order/{id} - Get an individual order
 	 *
@@ -13631,6 +13668,28 @@ export class ServiceClient extends BaseServiceClient {
 		return this.request('search', '/search/user', 'GET', `/search/user`, null, options);
 	}
 
+	/**
+	 * GET /search/discounts/{id} - Get discounts from search
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	get_search_discounts(
+		id: string,
+		options?: {
+			query?: GetSearchDiscountsQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetSearchDiscountsResponse> {
+		return this.request(
+			'search',
+			'/search/discounts/{id}',
+			'GET',
+			`/search/discounts/${id}`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * POST /auth/flow - Determines the authentication flow for a user based on their email address
 	 *
@@ -14022,4 +14081,144 @@ export class ServiceClient extends BaseServiceClient {
 			options,
 		);
 	}
+
+	/**
+	 * POST /forecasting/production-sheet - Create a new Production Sheet
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	ProductionSheetController_createSheet(
+		body: ProductionSheetControllerCreateSheetBody,
+		options?: RequestOptions,
+	): ResponsePromise<ProductionSheetControllerCreateSheetResponse> {
+		return this.request(
+			'forecasting',
+			'/forecasting/production-sheet',
+			'POST',
+			`/forecasting/production-sheet`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * GET /forecasting/scheduled-menu-data - Get scheduled menu data for a site for a given date
+	 *
+	 * @param options - additional request options
+	 */
+	ProductionSheetController_getScheduledMenuData(
+		options: {
+			query: ProductionSheetControllerGetScheduledMenuDataQuery;
+		} & RequestOptions,
+	): ResponsePromise<ProductionSheetControllerGetScheduledMenuDataResponse> {
+		return this.request(
+			'forecasting',
+			'/forecasting/scheduled-menu-data',
+			'GET',
+			`/forecasting/scheduled-menu-data`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * 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'
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	ProductionSheetController_saveItemForecastDifferential(
+		body: ProductionSheetControllerSaveItemForecastDifferentialBody,
+		options?: RequestOptions,
+	): ResponsePromise<ProductionSheetControllerSaveItemForecastDifferentialResponse> {
+		return this.request(
+			'forecasting',
+			'/forecasting/item-forecast-diff',
+			'POST',
+			`/forecasting/item-forecast-diff`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * POST /forecasting/chat - Relay a user chat message to Luna
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	ProductionSheetController_sendChatMessage(
+		body: ProductionSheetControllerSendChatMessageBody,
+		options?: RequestOptions,
+	): ResponsePromise<ProductionSheetControllerSendChatMessageResponse> {
+		return this.request(
+			'forecasting',
+			'/forecasting/chat',
+			'POST',
+			`/forecasting/chat`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * POST /forecasting/chat-feedback - Send user feedback for Luna chat messages
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	ProductionSheetController_sendChatFeedback(
+		body: ProductionSheetControllerSendChatFeedbackBody,
+		options?: RequestOptions,
+	): ResponsePromise<ProductionSheetControllerSendChatFeedbackResponse> {
+		return this.request(
+			'forecasting',
+			'/forecasting/chat-feedback',
+			'POST',
+			`/forecasting/chat-feedback`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * GET /forecasting/forecast-metadata - Get forecast meta data from Luna
+	 *
+	 * @param options - additional request options
+	 */
+	ProductionSheetController_getForecastMetaData(
+		options: {
+			query: ProductionSheetControllerGetForecastMetaDataQuery;
+		} & RequestOptions,
+	): ResponsePromise<ProductionSheetControllerGetForecastMetaDataResponse> {
+		return this.request(
+			'forecasting',
+			'/forecasting/forecast-metadata',
+			'GET',
+			`/forecasting/forecast-metadata`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * GET /forecasting/status
+	 *
+	 * @param options - additional request options
+	 */
+	ProductionSheetController_serviceStatus(
+		options?: {
+			query?: ProductionSheetControllerServiceStatusQuery;
+		} & RequestOptions,
+	): ResponsePromise<ProductionSheetControllerServiceStatusResponse> {
+		return this.request(
+			'forecasting',
+			'/forecasting/status',
+			'GET',
+			`/forecasting/status`,
+			null,
+			options,
+		);
+	}
 }

package/src/interface/consumer.ts

@@ -1892,6 +1892,7 @@ export interface ConsumerTimeslot {
 	duration?: string;
 	is_available?: boolean;
 	number_orders?: number;
+	delivery_destinations?: string[];
 }
 
 export interface PostConsumerLocationMarketplaceTimeslotsResponse {

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 {
@@ -239,3 +286,16 @@ export interface GetSearchUserQuery {
 }
 
 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;