@compassdigital/sdk.typescript 4.791.0 → 4.793.0

package/src/interface/centricos.ts

@@ -774,7 +774,7 @@ export interface CentricDiscountSchedule {
 	endTime: string;
 }
 
-export interface PutDiscountVoucherifyRequestDiscount {
+export interface PutCentricDiscountRequestDiscount {
 	// name of the discount
 	name: string;
 	// Discount method configuration
@@ -784,7 +784,7 @@ export interface PutDiscountVoucherifyRequestDiscount {
 	// item level config of the discount
 	itemLevelConfig?: CentricDiscountItemLevelConfig;
 	is?: CentricDiscountIs;
-	// Voucherify metadata
+	// discount metadata
 	meta?: CentricVoucherifyMetaDataDiscount;
 	// discount schedule
 	schedule?: CentricDiscountSchedule;
@@ -845,9 +845,9 @@ export interface DiscountBrand {
 	meta: DiscountBrandMeta;
 }
 
-export interface PutDiscountVoucherifyRequestDTO {
+export interface PutCentricDiscountRequestDTO {
 	// Discount to update
-	discount: PutDiscountVoucherifyRequestDiscount;
+	discount: PutCentricDiscountRequestDiscount;
 	// List of sites with metadata
 	sites?: DiscountSite[];
 	// List of brands with metadata
@@ -882,7 +882,7 @@ export interface DiscountResponseDTO {
 	type: 'Total Order' | 'Single Items' | 'Bundle';
 	// item level config of the discount
 	itemLevelConfig?: CentricDiscountItemLevelConfig;
-	// Voucherify metadata
+	// discount metadata
 	meta?: CentricVoucherifyMetaDataDiscount;
 	id: string;
 	createdAt: string;
@@ -891,7 +891,7 @@ export interface DiscountResponseDTO {
 	schedule?: Record<string, any>;
 }
 
-export interface PutDiscountVoucherifyResponseDTO {
+export interface PutCentricDiscountResponseDTO {
 	// Discount details
 	discount: DiscountResponseDTO;
 	// List of sites with metadata
@@ -915,6 +915,73 @@ export interface CentricDiscountMeta {
 	provider: CentricMetaProvider;
 }
 
+export interface PutCentricDiscountPublishResponseDTO {
+	// user is of discount creator
+	createdBy: string;
+	// last user who updated the discount
+	updatedBy: string;
+	// name of the discount
+	name: string;
+	// status of the discount
+	status: CentricDiscountStatus;
+	// Discount method configuration
+	method: CentricDiscountMethod;
+	// channel config of the discount
+	channelConfig: CentricDiscountChannelConfig;
+	// type of the discount
+	type: 'Total Order' | 'Single Items' | 'Bundle';
+	// item level config of the discount
+	itemLevelConfig?: CentricDiscountItemLevelConfig;
+	// discount metadata
+	meta?: CentricDiscountMeta;
+	// List of sites where discount is published
+	sites?: CentricDiscountEntityBase[];
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	is?: CentricDiscountIs;
+	schedule?: Record<string, any>;
+}
+
+export interface PutDiscountVoucherifyRequestDiscount {
+	// name of the discount
+	name: string;
+	// Discount method configuration
+	method: CentricDiscountMethod;
+	// channel config of the discount
+	channelConfig: CentricDiscountChannelConfig;
+	// item level config of the discount
+	itemLevelConfig?: CentricDiscountItemLevelConfig;
+	is?: CentricDiscountIs;
+	// discount metadata
+	meta?: CentricVoucherifyMetaDataDiscount;
+	// discount schedule
+	schedule?: CentricDiscountSchedule;
+	id?: string;
+	// discount active status flag
+	active?: boolean;
+	// type of the discount
+	type?: 'Total Order' | 'Single Items' | 'Bundle';
+}
+
+export interface PutDiscountVoucherifyRequestDTO {
+	// Discount to update
+	discount: PutDiscountVoucherifyRequestDiscount;
+	// List of sites with metadata
+	sites?: DiscountSite[];
+	// List of brands with metadata
+	brands?: DiscountBrand[];
+}
+
+export interface PutDiscountVoucherifyResponseDTO {
+	// Discount details
+	discount: DiscountResponseDTO;
+	// List of sites with metadata
+	sites: DiscountSite[];
+	// List of brands with metadata
+	brands: DiscountBrand[];
+}
+
 export interface PutDiscountVoucherifyPublishResponseDTO {
 	// user is of discount creator
 	createdBy: string;
@@ -943,6 +1010,10 @@ export interface PutDiscountVoucherifyPublishResponseDTO {
 	schedule?: Record<string, any>;
 }
 
+export interface DeleteCentricDiscountResponseDTO {
+	success: boolean;
+}
+
 export interface DeleteDiscountsVoucherifyResponseDTO {
 	success: boolean;
 }
@@ -1734,6 +1805,21 @@ export interface DeleteCentricosStationIntegrationPath {
 
 export type DeleteCentricosStationIntegrationResponse = DeleteStationIntegrationResponse;
 
+// PUT /centricos/discount - Add or Update a discount and assign it to multiple sites
+
+export type PutCentricosDiscountBody = PutCentricDiscountRequestDTO;
+
+export type PutCentricosDiscountResponse = PutCentricDiscountResponseDTO;
+
+// PUT /centricos/discount/{id}/publish - Update and publish a discount and assign it to multiple sites
+
+export interface PutCentricosDiscountPublishPath {
+	// Discount ID
+	id: string;
+}
+
+export type PutCentricosDiscountPublishResponse = PutCentricDiscountPublishResponseDTO;
+
 // PUT /centricos/discount/voucherify - Add or Update a voucherify discount and assign it to multiple sites
 
 export type PutCentricosDiscountVoucherifyBody = PutDiscountVoucherifyRequestDTO;
@@ -1749,14 +1835,14 @@ export interface PutCentricosDiscountVoucherifyPublishPath {
 
 export type PutCentricosDiscountVoucherifyPublishResponse = PutDiscountVoucherifyPublishResponseDTO;
 
-// DELETE /centricos/discount/{id}/voucherify - Delete a discount from voucherify and all of its entity associations
+// DELETE /centricos/discount/{id} - Delete a discount and all of its entity associations
 
-export interface DeleteCentricosDiscountsVoucherifyPath {
+export interface DeleteCentricosDiscountPath {
 	// Discount ID
 	id: string;
 }
 
-export type DeleteCentricosDiscountsVoucherifyResponse = DeleteDiscountsVoucherifyResponseDTO;
+export type DeleteCentricosDiscountResponse = DeleteCentricDiscountResponseDTO;
 
 // GET /centricos/discount/{id} - Get discount information by ID
 
@@ -1767,6 +1853,15 @@ export interface GetCentricosDiscountPath {
 
 export type GetCentricosDiscountResponse = GetDiscountResponseDTO;
 
+// DELETE /centricos/discount/{id}/voucherify - Delete a discount from voucherify and all of its entity associations
+
+export interface DeleteCentricosDiscountsVoucherifyPath {
+	// Discount ID
+	id: string;
+}
+
+export type DeleteCentricosDiscountsVoucherifyResponse = DeleteDiscountsVoucherifyResponseDTO;
+
 // GET /centricos/discounts - Get discounts with pagination and filtering
 
 export interface GetCentricosDiscountsQuery {

package/src/interface/config.ts

@@ -111,7 +111,7 @@ export interface PublicMealplanConfig {
 		fr?: string;
 	};
 	// Provider terminal id. Some site (group) configs store this as an array of strings instead of a scalar.
-	terminal_id?: string;
+	terminal_id?: string | string[];
 	tax_exempt?: boolean;
 	// Meal-exchange brand flag (station configs).
 	isBrandMX?: boolean;
@@ -156,6 +156,8 @@ export interface PrivateMealplanConfig {
 		port?: number;
 		vendor_number?: number;
 		client?: string;
+		// Blackboard eAccounts institution uuid used for meal-plan SSO. Spelled in camelCase unlike its siblings; that is the stored key.
+		institutionId?: string;
 		restricted?: KeystoreRestricted;
 	};
 }
@@ -202,6 +204,8 @@ export interface Tender {
 		hours?: string;
 	}[];
 	tender_number?: string;
+	// Cashless tender discriminator (`badge_pay`, `stipend`, `voucher`, `coupon_voucher`). Carried alongside `type` rather than replacing it.
+	tender_type?: string;
 	type?: string;
 	id?: string;
 	tax_exempt?: boolean;
@@ -266,6 +270,8 @@ export interface PublicStationConfig {
 		// Cashless provider account id; used as the tender lookup key at checkout.
 		id?: string;
 	};
+	// Minutes a checked-in order stays active before it is treated as stale. The order service falls back to a built-in default when this is unset.
+	checkin_buffer_time?: number;
 	// Named drop-off locations offered for delivery orders.
 	delivery_destinations?: string[];
 	// Drop-off locations that use automatic timeslot assignment.
@@ -305,9 +311,9 @@ export interface PublicStationConfig {
 	payment?: {
 		freedompay?: {
 			// FreedomPay store/terminal identifier.
-			freedompay_store_id?: number;
+			freedompay_store_id?: string;
 			// FreedomPay store/terminal identifier.
-			freedompay_terminal_id?: number;
+			freedompay_terminal_id?: string;
 		};
 	};
 	phone_number?: string;
@@ -334,6 +340,10 @@ export interface PublicStationConfig {
 	show_instructions?: boolean;
 	// Whether only a single fulfillment timeslot is offered.
 	show_single_timeslot?: boolean;
+	// Per-feature kill switch honoured by the web client only; the mobile apps ignore it.
+	web_features_disabled?: {
+		delivery?: boolean;
+	};
 }
 
 export interface PrivateStationConfig {
@@ -352,6 +362,8 @@ export interface PrivateStationConfig {
 		type?: string;
 		value?: number;
 	};
+	// Inbox that receives order-dispute notifications for this station, overriding the service-wide default. Distinct from `email`.
+	dispute_email?: string;
 	// Operator/admin notification email.
 	email?: string;
 	// Payment methods to reject or hide at checkout.
@@ -364,6 +376,12 @@ export interface PrivateStationConfig {
 		meal_swipes?: string[];
 		mealplan?: string[];
 	};
+	// Promo codes that cannot be redeemed at this station.
+	excluded_promocodes?: string[];
+	// Frictionless (scan-and-go / just-walk-out) settings for this station.
+	frictionless?: {
+		promo_code?: string;
+	};
 	id?: string;
 	// Whether guest check-in is enabled.
 	is_checkin_enabled?: boolean;
@@ -434,9 +452,12 @@ export interface PublicSiteConfig {
 	badge_pay?: {
 		id?: string;
 		name?: string;
+		tax_exempt?: boolean;
 		type?: string;
 		webview?: string;
 	};
+	// Whether the customer is prevented from choosing a timeslot.
+	block_timeslot_select?: boolean;
 	// Cashless tender configuration for the site.
 	cashless?: {
 		id?: string;
@@ -450,6 +471,17 @@ export interface PublicSiteConfig {
 		voucher_webview?: string;
 		webview?: string;
 	};
+	// Domain-based tax exemption: orders from these email domains are treated as tax-exempt.
+	email_tax_exempt?: {
+		domains?: string[];
+		enabled?: boolean;
+	};
+	// Whether frictionless (scan-and-go / just-walk-out) ordering is offered.
+	frictionless_supported?: boolean;
+	// Whether the entity has a Kitchen Display System.
+	has_kds?: boolean;
+	// Whether guest check-in is enabled.
+	is_checkin_enabled?: boolean;
 	// Just-Walk-Out configuration.
 	jwo?: {
 		enabled?: boolean;
@@ -461,8 +493,8 @@ export interface PublicSiteConfig {
 	// FreedomPay configuration for the site.
 	payment?: {
 		freedompay?: {
-			freedompay_store_id?: number;
-			freedompay_terminal_id?: number;
+			freedompay_store_id?: string;
+			freedompay_terminal_id?: string;
 		};
 	};
 	// Promotions available at this site.
@@ -477,6 +509,12 @@ export interface PublicSiteConfig {
 		is_mealplan_promo?: boolean;
 		name?: string;
 	}[];
+	// Whether delivery orders are routed to the runner app.
+	runner_app_enabled?: boolean;
+	// Whether only a single fulfillment timeslot is offered.
+	show_single_timeslot?: boolean;
+	// Item categories that stay taxable when the whole cart is otherwise exempt, keyed by the human-authored category name (which may contain spaces). Only categories mapped to true are applied.
+	tax_exemption_overrides?: Record<string, boolean>;
 }
 
 export interface PrivateSiteConfig {
@@ -507,6 +545,10 @@ export interface PrivateSiteConfig {
 	// Loyalty program configuration.
 	loyalty?: {
 		enabled?: boolean;
+		loyalty_emails?: {
+			email?: string;
+		}[];
+		provider_id?: string;
 	};
 	// Named service windows used for end-of-day reporting.
 	meal_periods?: {
@@ -539,15 +581,19 @@ export interface PrivateSiteConfig {
 export interface PrivateStationKeystore {
 	// FreedomPay credentials (encrypted at rest).
 	payment?: {
-		id?: string;
-		freedompay_store_id?: string;
-		freedompay_terminal_id?: string;
+		freedompay?: {
+			badge_pay_system_key?: string;
+			freedompay_store_id?: string;
+			freedompay_terminal_id?: string;
+			id?: string;
+		};
 	};
 	centric_hub?: {
 		// Card-present FreedomPay credentials for the merchant.
 		freedompay?: {
 			freedompay_store_id?: string;
 			freedompay_terminal_id?: string;
+			id?: string;
 		};
 	};
 	mealplan?: CbordMealplanConfig;
@@ -563,9 +609,12 @@ export interface PrivateStationKeystore {
 export interface PrivateSiteKeystore {
 	// FreedomPay credentials (encrypted at rest).
 	payment?: {
-		id?: string;
-		freedompay_store_id?: string;
-		freedompay_terminal_id?: string;
+		freedompay?: {
+			badge_pay_system_key?: string;
+			freedompay_store_id?: string;
+			freedompay_terminal_id?: string;
+			id?: string;
+		};
 	};
 	mealplan?: CbordMealplanConfig;
 	// Legacy pointer into the external keystore table.