@compassdigital/sdk.typescript 4.116.0 → 4.118.0

package/src/interface/mealplan.ts

@@ -217,9 +217,6 @@ export interface DeleteMealplanTenderBody {
 	type?: string;
 	conversion_amount?: number;
 	terminal_id?: string;
-	overrides?: {
-		credentials?: string;
-	};
 	drain_order_type?: {
 		taxable?: boolean;
 		tax_exempt?: boolean;
@@ -259,9 +256,6 @@ export interface PatchMealplanTenderBody {
 	// Amount for order paid by user
 	transaction_amount?: number;
 	terminal_id?: string;
-	overrides?: {
-		credentials?: string;
-	};
 }
 
 export type PatchMealplanTenderResponse = Tender;
@@ -270,27 +264,6 @@ export interface PatchMealplanTenderRequest extends BaseRequest, PatchMealplanTe
 	body: PatchMealplanTenderBody;
 }
 
-// POST /mealplan/{id}/tender/{tender} - Check the user's tender balance
-
-export interface PostMealplanTenderPath {
-	// Meal plan ID
-	id: string;
-	// Tender ID
-	tender: string;
-}
-
-export interface PostMealplanTenderBody {
-	overrides?: {
-		credentials?: string;
-	};
-}
-
-export type PostMealplanTenderResponse = Tender;
-
-export interface PostMealplanTenderRequest extends BaseRequest, PostMealplanTenderPath {
-	body: PostMealplanTenderBody;
-}
-
 // POST /mealplan/{id}/verify - Send verification email to user linking a mealplan
 
 export interface PostMealplanVerifyPath {
@@ -357,3 +330,88 @@ export interface PostMealplanAuthorizeResponse {
 export interface PostMealplanAuthorizeRequest extends BaseRequest, PostMealplanAuthorizePath {
 	body: PostMealplanAuthorizeBody;
 }
+
+// POST /mealplan/{id}/internal/tenders - Check the user's tender balance
+
+export interface PostMealplanInternalTendersPath {
+	// Meal plan ID
+	id: string;
+}
+
+export interface PostMealplanInternalTendersBody {
+	credentials: string;
+}
+
+export interface PostMealplanInternalTendersResponse {
+	tenders: Tender[];
+}
+
+export interface PostMealplanInternalTendersRequest
+	extends BaseRequest,
+		PostMealplanInternalTendersPath {
+	body: PostMealplanInternalTendersBody;
+}
+
+// POST /mealplan/{id}/internal/debit - Debit an amount from the tender balance
+
+export interface PostMealplanInternalDebitPath {
+	// Meal plan ID
+	id: string;
+}
+
+export interface PostMealplanInternalDebitBody {
+	credentials: string;
+	tender: string;
+	amount: number;
+	type?: string;
+	conversion_amount?: number;
+	terminal_id?: string;
+	drain_order_type?: {
+		taxable?: boolean;
+		tax_exempt?: boolean;
+	};
+}
+
+export interface PostMealplanInternalDebitResponse {
+	id?: string;
+	name?: string;
+	balance?: number;
+	is?: TenderIs;
+	transaction_id?: string;
+	type?: number;
+	tender_id?: number;
+	currency?: string;
+	transaction_amount?: number;
+	drained_tender_name?: string;
+	drained_tender_breakdown?: DrainedTender[];
+}
+
+export interface PostMealplanInternalDebitRequest
+	extends BaseRequest,
+		PostMealplanInternalDebitPath {
+	body: PostMealplanInternalDebitBody;
+}
+
+// POST /mealplan/{id}/internal/refund - Refund an amount to the tender balance
+
+export interface PostMealplanInternalRefundPath {
+	// Meal plan ID
+	id: string;
+}
+
+export interface PostMealplanInternalRefundBody {
+	credentials: string;
+	tender: string;
+	amount: number;
+	// Amount for order paid by user
+	transaction_amount?: number;
+	terminal_id?: string;
+}
+
+export type PostMealplanInternalRefundResponse = Tender;
+
+export interface PostMealplanInternalRefundRequest
+	extends BaseRequest,
+		PostMealplanInternalRefundPath {
+	body: PostMealplanInternalRefundBody;
+}

package/src/interface/menu.ts

@@ -725,7 +725,6 @@ export interface DraftItemToModifierGroupRelationshipDTO {
 	brand?: DraftBrandDTO;
 	changes?: ItemToModifierGroupRelationshipChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
-	is_global?: boolean;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -771,7 +770,6 @@ export interface DraftModifierGroupToModifierRelationshipDTO {
 	brand?: DraftBrandDTO;
 	changes?: ModifierGroupToModifierRelationshipChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
-	is_global?: boolean;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -1096,6 +1094,20 @@ export interface ApplyDiffDTO {
 	[index: string]: any;
 }
 
+export interface WarningDTO {
+	barcode?: string;
+	brand_id?: string;
+	brand_name?: string;
+	type?: string;
+	items?: WarningItemDTO[];
+}
+
+export interface WarningItemDTO {
+	id?: string;
+	item_name?: string;
+	posid?: string;
+}
+
 export interface PublishedMenuDTO {
 	id?: string;
 	parent_id?: string;
@@ -1166,7 +1178,6 @@ export interface PublishedItemToModifierGroupRelationshipDTO {
 	item_id?: string;
 	brand_id?: string;
 	sequence?: number;
-	is_global?: boolean;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -1196,7 +1207,6 @@ export interface PublishedModifierGroupToModifierRelationshipDTO {
 	modifier_group_id?: string;
 	brand_id?: string;
 	sequence?: number;
-	is_global?: boolean;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -1231,21 +1241,6 @@ export interface PublishedModifierDTO {
 	[index: string]: any;
 }
 
-export interface WarningDTO {
-	barcode?: string;
-	type?: string;
-	items?: WarningItemDTO[];
-}
-
-export interface WarningItemDTO {
-	id?: string;
-	item_name?: string;
-	barcode?: string;
-	posid?: string;
-	brand_id?: string;
-	brand_name?: string;
-}
-
 export interface GroupStockUpdate {
 	id: string;
 	items?: ItemStockUpdate[];
@@ -3592,6 +3587,26 @@ export interface PostMenuV3DraftBrandImportRequest
 	extends BaseRequest,
 		PostMenuV3DraftBrandImportPath {}
 
+// GET /menu/v3/draft/brand/{id}/verify-publish
+
+export interface GetMenuV3DraftBrandVerifyPublishPath {
+	id: string;
+}
+
+export interface GetMenuV3DraftBrandVerifyPublishQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export interface GetMenuV3DraftBrandVerifyPublishResponse {
+	warnings?: WarningDTO[];
+}
+
+export interface GetMenuV3DraftBrandVerifyPublishRequest
+	extends BaseRequest,
+		RequestQuery<GetMenuV3DraftBrandVerifyPublishQuery>,
+		GetMenuV3DraftBrandVerifyPublishPath {}
+
 // POST /menu/v3/brand
 
 export interface PostMenuV3BrandQuery {
@@ -5585,7 +5600,6 @@ export interface PostMenuV3DraftItemRelationshipsModifierGroupBody {
 	brand?: DraftBrandDTO;
 	changes?: ItemToModifierGroupRelationshipChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
-	is_global?: boolean;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -5642,7 +5656,6 @@ export interface PatchMenuV3DraftItemRelationshipsModifierGroupBody {
 	brand?: DraftBrandDTO;
 	changes?: ItemToModifierGroupRelationshipChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
-	is_global?: boolean;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -5721,7 +5734,6 @@ export type PostMenuV3DraftItemRelationshipsModifierGroupsBody = {
 	brand?: DraftBrandDTO;
 	changes?: ItemToModifierGroupRelationshipChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
-	is_global?: boolean;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }[];
@@ -6223,7 +6235,6 @@ export interface PostMenuV3DraftModifierGroupRelationshipsModifierBody {
 	brand?: DraftBrandDTO;
 	changes?: ModifierGroupToModifierRelationshipChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
-	is_global?: boolean;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -6280,7 +6291,6 @@ export interface PatchMenuV3DraftModifierGroupRelationshipsModifierBody {
 	brand?: DraftBrandDTO;
 	changes?: ModifierGroupToModifierRelationshipChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
-	is_global?: boolean;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -6359,7 +6369,6 @@ export type PostMenuV3DraftModifierGroupRelationshipsModifiersBody = {
 	brand?: DraftBrandDTO;
 	changes?: ModifierGroupToModifierRelationshipChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
-	is_global?: boolean;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }[];
@@ -8018,27 +8027,6 @@ export interface PostMenuV4BrandMenuDuplicateRequest
 	body: PostMenuV4BrandMenuDuplicateBody;
 }
 
-// POST /menu/v4/category/{id}/attachment/{name}
-
-export interface PostMenuV4CategoryAttachmentPath {
-	id: string;
-	name: 'thumbnail';
-}
-
-export interface PostMenuV4CategoryAttachmentQuery {
-	'body.data'?: string;
-	'body.brand_id'?: string;
-}
-
-export interface PostMenuV4CategoryAttachmentResponse {
-	status?: string;
-}
-
-export interface PostMenuV4CategoryAttachmentRequest
-	extends BaseRequest,
-		RequestQuery<PostMenuV4CategoryAttachmentQuery>,
-		PostMenuV4CategoryAttachmentPath {}
-
 // POST /menu/v4/item/{id}/attachment/{name}
 
 export interface PostMenuV4ItemAttachmentPath {
@@ -8601,6 +8589,45 @@ export interface PostMenuV4ItemDuplicateRequest extends BaseRequest, PostMenuV4I
 	body: PostMenuV4ItemDuplicateBody;
 }
 
+// DELETE /menu/v4/item/{id}/modifier-groups/detach
+
+export interface DeleteMenuV4ItemModifierGroupsDetachPath {
+	id: string;
+}
+
+export type DeleteMenuV4ItemModifierGroupsDetachBody = {
+	parent?: DraftItemToModifierGroupRelationshipDTO;
+	children?: DraftItemToModifierGroupRelationshipDTO[];
+	id: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
+	parent_id?: string;
+	modifier_group_id: string;
+	item_id: string;
+	brand_id: string;
+	sequence?: number;
+	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
+	item?: DraftItemDTO;
+	modifier_group?: DraftModifierGroupDTO;
+	brand?: DraftBrandDTO;
+	changes?: ItemToModifierGroupRelationshipChangeDTO[];
+	vendor_metadata?: VendorMetadataDTO[];
+	permissions?: Record<string, any>;
+	[index: string]: any;
+}[];
+
+export interface DeleteMenuV4ItemModifierGroupsDetachResponse {
+	status?: string;
+}
+
+export interface DeleteMenuV4ItemModifierGroupsDetachRequest
+	extends BaseRequest,
+		DeleteMenuV4ItemModifierGroupsDetachPath {
+	body: DeleteMenuV4ItemModifierGroupsDetachBody;
+}
+
 // POST /menu/v4/modifier
 
 export interface PostMenuV4ModifierBody {
@@ -9303,7 +9330,6 @@ export type PostMenuV4ModifierGroupAttachModifiersBody = {
 	brand?: DraftBrandDTO;
 	changes?: ModifierGroupToModifierRelationshipChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
-	is_global?: boolean;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }[];
@@ -9390,6 +9416,45 @@ export interface PostMenuV4ModifierGroupDuplicateRequest
 	body: PostMenuV4ModifierGroupDuplicateBody;
 }
 
+// DELETE /menu/v4/modifier-group/{id}/modifiers/detach
+
+export interface DeleteMenuV4ModifierGroupModifiersDetachPath {
+	id: string;
+}
+
+export type DeleteMenuV4ModifierGroupModifiersDetachBody = {
+	parent?: DraftModifierGroupToModifierRelationshipDTO;
+	children?: DraftModifierGroupToModifierRelationshipDTO[];
+	id: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
+	parent_id?: string;
+	modifier_id: string;
+	modifier_group_id: string;
+	brand_id: string;
+	sequence?: number;
+	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
+	modifier?: DraftModifierDTO;
+	modifier_group?: DraftModifierGroupDTO;
+	brand?: DraftBrandDTO;
+	changes?: ModifierGroupToModifierRelationshipChangeDTO[];
+	vendor_metadata?: VendorMetadataDTO[];
+	permissions?: Record<string, any>;
+	[index: string]: any;
+}[];
+
+export interface DeleteMenuV4ModifierGroupModifiersDetachResponse {
+	status?: string;
+}
+
+export interface DeleteMenuV4ModifierGroupModifiersDetachRequest
+	extends BaseRequest,
+		DeleteMenuV4ModifierGroupModifiersDetachPath {
+	body: DeleteMenuV4ModifierGroupModifiersDetachBody;
+}
+
 // PATCH /menu/v4/stock/business-unit
 
 export interface PatchMenuV4StockBusinessUnitBody {
@@ -9625,3 +9690,63 @@ export interface PostMenuV4UnscheduleMenuResponse {
 export interface PostMenuV4UnscheduleMenuRequest extends BaseRequest {
 	body: PostMenuV4UnscheduleMenuBody;
 }
+
+// POST /menu/v4/category/{id}/attachment/{name}
+
+export interface PostMenuV4CategoryAttachmentPath {
+	id: string;
+	name: 'thumbnail';
+}
+
+export interface PostMenuV4CategoryAttachmentQuery {
+	'body.data'?: string;
+	'body.brand_id'?: string;
+}
+
+export interface PostMenuV4CategoryAttachmentResponse {
+	status?: string;
+}
+
+export interface PostMenuV4CategoryAttachmentRequest
+	extends BaseRequest,
+		RequestQuery<PostMenuV4CategoryAttachmentQuery>,
+		PostMenuV4CategoryAttachmentPath {}
+
+// DELETE /menu/v4/category/{id}/detach-items
+
+export interface DeleteMenuV4CategoryDetachItemsPath {
+	id: string;
+}
+
+export type DeleteMenuV4CategoryDetachItemsBody = {
+	parent?: DraftCategoryToItemRelationshipDTO;
+	children?: DraftCategoryToItemRelationshipDTO[];
+	id: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
+	parent_id?: string;
+	item_id: string;
+	category_id: string;
+	brand_id: string;
+	sequence?: number;
+	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
+	category?: DraftCategoryDTO;
+	item?: DraftItemDTO;
+	brand?: DraftBrandDTO;
+	changes?: CategoryToItemRelationshipChangeDTO[];
+	vendor_metadata?: VendorMetadataDTO[];
+	permissions?: Record<string, any>;
+	[index: string]: any;
+}[];
+
+export interface DeleteMenuV4CategoryDetachItemsResponse {
+	status?: string;
+}
+
+export interface DeleteMenuV4CategoryDetachItemsRequest
+	extends BaseRequest,
+		DeleteMenuV4CategoryDetachItemsPath {
+	body: DeleteMenuV4CategoryDetachItemsBody;
+}

package/src/interface/partner.ts

@@ -62,6 +62,43 @@ export interface ShoppingCartResponse {
 		order_loyalty_points?: boolean;
 	};
 	discount?: ShoppingCartResponse['promo'];
+	discounts?: {
+		id: string;
+		// unix epoch timestamp of discount creation in UTC
+		createdAt: string;
+		// unix epoch timestamp of discount update in UTC
+		updatedAt: string;
+		// id of the user who created the discount
+		createdBy: string;
+		// id of the user who updated the discount most recently
+		updatedBy: string;
+		name: string;
+		is?: {
+			badgepayPromo?: boolean;
+			mealplanPromo?: boolean;
+			decliningBalancePromo?: boolean;
+			voucherPromo?: boolean;
+		};
+		status?: {
+			live?: boolean;
+			publishedTo3rdParty?: boolean;
+			readyToPublish?: boolean;
+		};
+		meta?: {
+			provider: {
+				// Voucherify metadata
+				voucherify?: {
+					id?: string;
+					code?: string;
+					discount?: {
+						type: string;
+						amountOff?: number;
+						percentOff?: number;
+					};
+				};
+			};
+		};
+	}[];
 	payment_method?: {
 		// Mealplan payment details
 		mealplan?: {
@@ -373,6 +410,14 @@ export interface LocationGroup {
 		alt_logo?: string | null;
 	};
 	timezone?: string;
+	device_mapping?: Record<
+		string,
+		{
+			device_type?: string;
+			site_device_id?: string;
+			name?: string;
+		}[]
+	>;
 	[index: string]: any;
 }
 
@@ -476,7 +521,7 @@ export interface Brand {
 		{
 			device_type: string;
 			site_device_id: string;
-			business_units: string[];
+			business_units?: string[];
 		}[]
 	>;
 	timeslots?: {
@@ -566,11 +611,21 @@ export interface Brand {
 			jwo?: string;
 			time2eat?: {
 				enabled?: boolean;
+				use_timeslots?: boolean;
+				ignore_station_hours?: boolean;
 			};
 			nextep?: {
 				mobile_app?: boolean;
+				web?: boolean;
 			};
 		};
+		type_of_kds?: {
+			cdl?: boolean;
+			nextep?: boolean;
+			volante?: boolean;
+			agilysys?: boolean;
+			[index: string]: any;
+		};
 		[index: string]: any;
 	};
 	descriptions?: {
@@ -658,7 +713,6 @@ export interface WaitTime {
 }
 
 export interface Menu {
-	// menu
 	id?: string;
 	date?: {
 		created?: string;
@@ -669,13 +723,9 @@ export interface Menu {
 		en?: string;
 	};
 	groups?: Group[];
-	// menu
 	parent_id?: string;
-	// brand
 	location_brand?: string;
-	// company
 	company?: string;
-	// sector
 	sector?: string;
 	is?: {
 		disabled?: boolean;
@@ -713,7 +763,6 @@ export interface Menu {
 }
 
 export interface Group {
-	// group
 	id?: string;
 	name?: string;
 	label?: {
@@ -721,7 +770,6 @@ export interface Group {
 		fr?: string;
 	};
 	items?: {
-		// item
 		id?: string;
 		label?: {
 			en?: string;
@@ -791,7 +839,6 @@ export interface Group {
 			salt_free?: boolean;
 		};
 		options?: {
-			// modifier_group
 			id?: string;
 			label?: {
 				en?: string;
@@ -799,7 +846,6 @@ export interface Group {
 			unique_name?: string;
 			name?: string;
 			items?: {
-				// option
 				id?: string;
 				label?: {
 					en?: string;

package/test/client.test.ts

@@ -49,7 +49,7 @@ describe('ServiceClient', () => {
 	test('headers get merged', async () => {
 		const intercept = jest.fn(interceptor(200));
 		const api = new ServiceClient({
-			stage: 'test',
+			stage: 'dev',
 			intercept,
 			headers: {
 				a: 'a from constructor',
@@ -114,6 +114,11 @@ describe('ServiceClient', () => {
 		expect(query).toEqual({ foo: 'test', things: ['1', '2', '3'] });
 	});
 
+	test('client throws if invalid stage is passed', async () => {
+		const api = new ServiceClient({ stage: 'invalid', intercept: interceptor(500) });
+		await expect(api.get_task('')).rejects.toBeInstanceOf(Error);
+	});
+
 	describe('ServiceError', () => {
 		// see: https://github.com/microsoft/TypeScript/issues/13965
 		test('is instance of itself', async () => {