@compassdigital/sdk.typescript 4.792.0 → 4.794.0

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?: {
@@ -536,18 +578,77 @@ export interface PrivateSiteConfig {
 	};
 }
 
+export interface PublicBusinessUnitConfig {
+	// Badge-pay (campus card) configuration for the business unit.
+	badge_pay?: {
+		id?: string;
+		name?: string;
+		type?: string;
+		webview?: string;
+	};
+	// Whether the customer is prevented from choosing a timeslot.
+	block_timeslot_select?: boolean;
+	// Cashless tender configuration for the business unit.
+	cashless?: {
+		id?: string;
+		name?: string;
+		tenders?: {
+			name?: string;
+			tax_exempt?: boolean;
+			tender_type?: string;
+		}[];
+		type?: string;
+		voucher_webview?: string;
+		webview?: string;
+	};
+	// Whether in-app chat is offered.
+	chat_enabled?: boolean;
+	// Whether the entity has a Kitchen Display System.
+	has_kds?: boolean;
+	// Whether guest check-in is enabled.
+	is_checkin_enabled?: boolean;
+	// Meal-plan configuration offered at this business unit.
+	mealplan?: PublicMealplanConfig[];
+	// Whether delivery orders are routed to the runner app. Written by the centricos edge's business unit drop-off route.
+	runner_app_enabled?: boolean;
+	// Whether pickup/delivery instructions are shown to the customer. Written by the centricos edge's business unit drop-off route.
+	show_instructions?: boolean;
+	// Whether only a single fulfillment timeslot is offered. Written by the centricos edge's business unit drop-off route.
+	show_single_timeslot?: boolean;
+}
+
+export interface PrivateBusinessUnitConfig {
+	// Delivery fee applied to delivery orders from this business unit.
+	delivery_fee?: {
+		// Fee unit. The only writer, the centricos edge's business unit drop-off route, always writes `dollar`.
+		type?: string;
+		value?: number;
+	};
+	// KDS routing configuration. On a business unit document this array holds exactly one entry, the unit's own, whereas on a site document it holds one entry per unit in the site. That is why the task service (`src/service/kds.ts`) reads index `0` and comments that only the first entry matters: correct against a business unit key, wrong against a site key.
+	kds_configurations?: {
+		// Identifier of the business unit this entry applies to. Typed as a string or a number because the only writer, ap3's marketplace view, sets it from the cost-centre string on `location.meta.unit`, while numeric values also exist in stored records.
+		business_unit_id?: string | number;
+		// Whether this business unit routes to an expediter KDS.
+		has_expediter_kds?: boolean;
+	}[];
+}
+
 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 +664,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.
@@ -787,6 +891,66 @@ export interface PutConfigSitePublicRequest extends BaseRequest, PutConfigSitePu
 	body: PutConfigSitePublicBody;
 }
 
+// GET /config/business-unit/{key}/private - Get a business unit's private configuration
+
+export interface GetConfigBusinessUnitPrivatePath {
+	// business unit key (a location/location id)
+	key: string;
+}
+
+export type GetConfigBusinessUnitPrivateResponse = PrivateBusinessUnitConfig;
+
+export interface GetConfigBusinessUnitPrivateRequest
+	extends BaseRequest,
+		GetConfigBusinessUnitPrivatePath {}
+
+// PUT /config/business-unit/{key}/private - Update a business unit's private configuration
+
+export interface PutConfigBusinessUnitPrivatePath {
+	// business unit key (a location/location id)
+	key: string;
+}
+
+export type PutConfigBusinessUnitPrivateBody = PrivateBusinessUnitConfig;
+
+export type PutConfigBusinessUnitPrivateResponse = PrivateBusinessUnitConfig;
+
+export interface PutConfigBusinessUnitPrivateRequest
+	extends BaseRequest,
+		PutConfigBusinessUnitPrivatePath {
+	body: PutConfigBusinessUnitPrivateBody;
+}
+
+// GET /config/business-unit/{key}/public - Get a business unit's public configuration
+
+export interface GetConfigBusinessUnitPublicPath {
+	// business unit key (a location/location id)
+	key: string;
+}
+
+export type GetConfigBusinessUnitPublicResponse = PublicBusinessUnitConfig;
+
+export interface GetConfigBusinessUnitPublicRequest
+	extends BaseRequest,
+		GetConfigBusinessUnitPublicPath {}
+
+// PUT /config/business-unit/{key}/public - Update a business unit's public configuration
+
+export interface PutConfigBusinessUnitPublicPath {
+	// business unit key (a location/location id)
+	key: string;
+}
+
+export type PutConfigBusinessUnitPublicBody = PublicBusinessUnitConfig;
+
+export type PutConfigBusinessUnitPublicResponse = PublicBusinessUnitConfig;
+
+export interface PutConfigBusinessUnitPublicRequest
+	extends BaseRequest,
+		PutConfigBusinessUnitPublicPath {
+	body: PutConfigBusinessUnitPublicBody;
+}
+
 // GET /config/health - Config Service readiness and dependency health check
 
 export type GetConfigHealthResponse = HealthResponse;