@compassdigital/sdk.typescript 4.764.0 → 4.766.0

package/manifest.json

@@ -175,6 +175,13 @@
 		{
 			"name": "delivery",
 			"swagger": "../../api/platform2/delivery/swagger.json"
+		},
+		{
+			"name": "centric-pos",
+			"swagger": "../../api/platform2/edges/centric-pos/swagger.json",
+			"options": {
+				"request": false
+			}
 		}
 	]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.764.0",
+	"version": "4.766.0",
 	"description": "Compass Digital Labs TypeScript SDK",
 	"type": "commonjs",
 	"main": "./lib/index.js",

package/src/index.ts

@@ -1641,6 +1641,23 @@ import {
 	GetDeliveryOrdersResponse,
 } from './interface/delivery';
 
+import {
+	GetCentricPosConfigResponse,
+	UnregisterQuery,
+	UnregisterResponse,
+	RegisterBody,
+	RegisterResponse,
+	GetSiteResponse$0,
+	AuthBody,
+	AuthResponse,
+	PostCentricPosOrderBody,
+	PostCentricPosOrderResponse,
+	PatchCentricPosOrderReceiptEmailBody,
+	PatchCentricPosOrderReceiptEmailResponse,
+	GetDigitalSignageOrdersQuery,
+	GetDigitalSignageOrdersResponse,
+} from './interface/centric-pos';
+
 import { BaseServiceClient, RequestOptions, ServiceClientOptions, ResponsePromise } from './base';
 export * from './base';
 
@@ -18756,4 +18773,159 @@ export class ServiceClient extends BaseServiceClient {
 			options,
 		);
 	}
+
+	/**
+	 * GET /centric-pos/v1/config/{stationId} - Get Centric POS config
+	 *
+	 * @param stationId - Station identifier
+	 * @param options - additional request options
+	 */
+	get_centric_pos_config(
+		stationId: string,
+		options?: RequestOptions,
+	): ResponsePromise<GetCentricPosConfigResponse> {
+		return this.request(
+			'centric-pos',
+			'/centric-pos/v1/config/{stationId}',
+			'GET',
+			`/centric-pos/v1/config/${stationId}`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * DELETE /centric-pos/v1/unregister - Unregister a POS device by serial number
+	 *
+	 * @param options - additional request options
+	 */
+	unregister(
+		options: {
+			query: UnregisterQuery;
+		} & RequestOptions,
+	): ResponsePromise<UnregisterResponse> {
+		return this.request(
+			'centric-pos',
+			'/centric-pos/v1/unregister',
+			'DELETE',
+			`/centric-pos/v1/unregister`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * POST /centric-pos/v1/register - Register a POS device by serial number
+	 *
+	 * @param body - Serial number of the device to register
+	 * @param options - additional request options
+	 */
+	register(body: RegisterBody, options?: RequestOptions): ResponsePromise<RegisterResponse> {
+		return this.request(
+			'centric-pos',
+			'/centric-pos/v1/register',
+			'POST',
+			`/centric-pos/v1/register`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * GET /centric-pos/v1/site/{siteId} - Get stations with Centric POS integration and FreedomPay configured for a site
+	 *
+	 * @param siteId - Site (location group) identifier
+	 * @param options - additional request options
+	 */
+	get_site(siteId: string, options?: RequestOptions): ResponsePromise<GetSiteResponse$0> {
+		return this.request(
+			'centric-pos',
+			'/centric-pos/v1/site/{siteId}',
+			'GET',
+			`/centric-pos/v1/site/${siteId}`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * POST /centric-pos/v1/auth - Authenticate with serial number and long-term token to get short-term token
+	 *
+	 * @param body - Serial number and long-term token for authentication
+	 * @param options - additional request options
+	 */
+	auth(body: AuthBody, options?: RequestOptions): ResponsePromise<AuthResponse> {
+		return this.request(
+			'centric-pos',
+			'/centric-pos/v1/auth',
+			'POST',
+			`/centric-pos/v1/auth`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * POST /centric-pos/v1/order - Create a POS order
+	 *
+	 * @param body - Order data to create
+	 * @param options - additional request options
+	 */
+	post_centric_pos_order(
+		body: PostCentricPosOrderBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostCentricPosOrderResponse> {
+		return this.request(
+			'centric-pos',
+			'/centric-pos/v1/order',
+			'POST',
+			`/centric-pos/v1/order`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * PATCH /centric-pos/v1/order/{order_id}/receipt-email - Update order receipt email
+	 *
+	 * @param order_id - The order ID
+	 * @param body - Receipt email address
+	 * @param options - additional request options
+	 */
+	patch_centric_pos_order_receipt_email(
+		order_id: string,
+		body: PatchCentricPosOrderReceiptEmailBody,
+		options?: RequestOptions,
+	): ResponsePromise<PatchCentricPosOrderReceiptEmailResponse> {
+		return this.request(
+			'centric-pos',
+			'/centric-pos/v1/order/{order_id}/receipt-email',
+			'PATCH',
+			`/centric-pos/v1/order/${order_id}/receipt-email`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * GET /centric-pos/innovation/v1/digital-signage/orders/{stationId} - Get in-progress and ready orders for a station
+	 *
+	 * @param stationId - Station identifier
+	 * @param options - additional request options
+	 */
+	get_digital_signage_orders(
+		stationId: string,
+		options?: {
+			query?: GetDigitalSignageOrdersQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetDigitalSignageOrdersResponse> {
+		return this.request(
+			'centric-pos',
+			'/centric-pos/innovation/v1/digital-signage/orders/{stationId}',
+			'GET',
+			`/centric-pos/innovation/v1/digital-signage/orders/${stationId}`,
+			null,
+			options,
+		);
+	}
 }

package/src/interface/centric-pos.ts

@@ -0,0 +1,342 @@
+/* eslint-disable */
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+import { RequestQuery, BaseRequest } from './util';
+
+export interface CentricPOSConfigResponse {
+	// FreedomPay Store ID
+	freedomPayStoreId: string;
+	// FreedomPay TerminalId
+	freedomPayTerminalId: string;
+	// FreedomPay ES Token
+	freedomPayEsToken: string;
+	// FreedomPay AMA Key
+	freedomPayAmaKey: string;
+}
+
+export interface ErrorDisplayMessage {
+	// user message title
+	title: string;
+	// user message description
+	description: string;
+}
+
+export interface ErrorData {
+	// http status code
+	statusCode: number;
+	// http status text
+	statusText: string;
+	timestamp: string;
+	// user friendly error message
+	displayMessage: ErrorDisplayMessage;
+}
+
+export interface Error {
+	// business error code
+	code: number;
+	// business error description
+	message: string;
+	// additional error data
+	data: ErrorData;
+}
+
+export interface CentricPOSRegisterPostBody {
+	// Serial number of the device to register
+	serialNumber: string;
+}
+
+export interface CentricPOSRegisterResponse {
+	// Registration token for the device
+	token: string;
+	// Site ID associated with the device
+	siteId: string;
+}
+
+export interface Label {
+	en?: string;
+	fr?: string;
+}
+
+export interface TimeslotsDTO {
+	time?: string;
+	averagePrepTime?: string;
+	duration_minutes?: number;
+	customers_per_slot?: number;
+	menu_items_per_slot?: number;
+}
+
+export interface BrandDTO {
+	id?: string;
+	deleted_at?: string;
+	sector?: string;
+	name?: string;
+	label?: Label;
+	sequence?: number;
+	timezone?: string;
+	description?: string;
+	latitude?: number;
+	longitude?: number;
+	address?: Record<string, any>;
+	menus?: Record<string, any>[];
+	date?: Record<string, any>;
+	hours?: Record<string, any>[];
+	brand?: string;
+	location?: string;
+	group?: string;
+	location_description?: string;
+	timeslots?: TimeslotsDTO;
+}
+
+export interface GetSiteResponse {
+	// List of stations that have Centric POS configured
+	stations: BrandDTO[];
+}
+
+export interface CentricPOSAuthPostBody {
+	// Serial number of the device
+	serialNumber: string;
+	// Long-term token for authentication
+	longTermToken: string;
+}
+
+export interface CentricPOSAuthResponse {
+	// Short-term token
+	shortTermToken: string;
+	// Expiry time of the short-term token (ISO 8601 format)
+	shortTermTokenExpires: string;
+}
+
+export interface POSPayment {
+	// Payment type (e.g. Centric Hub)
+	type?: string;
+	// Transaction details (e.g. success, status, amount, requestID, reasonCode + provider keys)
+	transaction?: Record<string, any>;
+}
+
+export interface Payment {
+	// POS payment
+	pos?: POSPayment;
+}
+
+export interface CreatePOSOrderIs {
+	// Order in progress
+	in_progress?: boolean;
+	// Order ready
+	ready?: boolean;
+}
+
+export interface CreatePOSOrderMetaPosCashier {
+	// Cashier first name
+	firstName?: string;
+	// Cashier last name
+	lastName?: string;
+	// Cashier employee number
+	employeeNumber?: string;
+}
+
+export interface CreatePOSOrderMetaPos {
+	// Cashier info
+	cashier?: CreatePOSOrderMetaPosCashier;
+}
+
+export interface CreatePOSOrderMeta {
+	// Order source
+	source?: 'centric_hub';
+	// Override active flag for testing
+	active_override?: boolean;
+	// POS-specific meta
+	pos?: CreatePOSOrderMetaPos;
+}
+
+export interface OrderDetails {
+	// Display name (e.g. pickup name)
+	name?: string;
+	// Order type (e.g. pickup)
+	order_type?: string;
+	// Display ID
+	display_id?: string;
+	// Receipt email address
+	receiptEmail?: string;
+}
+
+export interface CreatePOSOrder {
+	// The location brand (station ID)
+	location_brand: string;
+	// The location
+	location?: string;
+	// The shoppingcart
+	shoppingcart?: string;
+	// Payment details
+	payment?: Payment;
+	// User ID
+	customer?: string;
+	// Order status flags
+	is?: CreatePOSOrderIs;
+	// Meta information
+	meta?: CreatePOSOrderMeta;
+	// Requested date (ISO 8601)
+	requested_date?: string;
+	// Order details
+	details?: OrderDetails;
+}
+
+export interface OrderIs {
+	// Order accepted
+	accepted?: boolean;
+	// Order in progress
+	in_progress?: boolean;
+	// Order ready
+	ready?: boolean;
+	// Out for delivery
+	out_for_delivery?: boolean;
+	// Delivered
+	delivered?: boolean;
+	// Collected
+	collected?: boolean;
+	// Cancelled
+	cancelled?: boolean;
+}
+
+export interface OrderDate {
+	// Accepted date (ISO 8601)
+	accepted?: string;
+	// Created date (ISO 8601)
+	created?: string;
+	// Modified date (ISO 8601)
+	modified?: string;
+	// Ready date (ISO 8601)
+	ready?: string;
+	// Started date (ISO 8601)
+	started?: string;
+	// Cancelled date (ISO 8601)
+	cancelled?: string;
+}
+
+export interface OrderMeta {
+	// Order source
+	source?: 'web' | 'mobile' | 'centric_hub';
+	// Active override
+	active_override?: boolean;
+	// POS meta
+	pos?: CreatePOSOrderMetaPos;
+}
+
+export interface Order {
+	// Order ID
+	id?: string;
+	// Brand/Station ID
+	location_brand?: string;
+	// Location/Site ID
+	location?: string;
+	// Shopping cart ID
+	shoppingcart?: string;
+	// Payment details
+	payment?: Payment;
+	// User ID
+	customer?: string;
+	// Order status flags
+	is?: OrderIs;
+	// Order date info
+	date?: OrderDate;
+	// Requested date
+	requested_date?: string;
+	// Order details
+	details?: OrderDetails;
+	// Order meta info
+	meta?: OrderMeta;
+}
+
+export interface PatchOrderReceiptEmailRequest {
+	// Email address for receipt
+	receiptEmail: string;
+}
+
+export interface DigitalSignageOrder {
+	// Display ID for the order
+	displayId: string;
+	// Customer's first name, or null when the DIGITAL_SIGNAGE_SHOW_NAME feature flag is not enabled for the station or no name is available
+	displayName: string | null;
+}
+
+export interface DigitalSignageOrdersResponse {
+	// Orders in progress
+	inProgress: DigitalSignageOrder[];
+	// Ready orders from the past N minutes
+	ready: DigitalSignageOrder[];
+}
+
+// GET /centric-pos/v1/config/{stationId} - Get Centric POS config
+
+export interface GetCentricPosConfigPath {
+	// Station identifier
+	stationId: string;
+}
+
+export type GetCentricPosConfigResponse = CentricPOSConfigResponse;
+
+// DELETE /centric-pos/v1/unregister - Unregister a POS device by serial number
+
+export interface UnregisterQuery {
+	// Serial number of the device to unregister
+	serialNumber: string;
+}
+
+export type UnregisterResponse = {};
+
+// POST /centric-pos/v1/register - Register a POS device by serial number
+
+export type RegisterBody = CentricPOSRegisterPostBody;
+
+export type RegisterResponse = CentricPOSRegisterResponse;
+
+// GET /centric-pos/v1/site/{siteId} - Get stations with Centric POS integration and FreedomPay configured for a site
+
+export interface GetSitePath {
+	// Site (location group) identifier
+	siteId: string;
+}
+
+export type GetSiteResponse$0 = GetSiteResponse;
+
+// POST /centric-pos/v1/auth - Authenticate with serial number and long-term token to get short-term token
+
+export type AuthBody = CentricPOSAuthPostBody;
+
+export type AuthResponse = CentricPOSAuthResponse;
+
+// POST /centric-pos/v1/order - Create a POS order
+
+export type PostCentricPosOrderBody = CreatePOSOrder;
+
+export type PostCentricPosOrderResponse = Order;
+
+// PATCH /centric-pos/v1/order/{order_id}/receipt-email - Update order receipt email
+
+export interface PatchCentricPosOrderReceiptEmailPath {
+	// The order ID
+	order_id: string;
+}
+
+export type PatchCentricPosOrderReceiptEmailBody = PatchOrderReceiptEmailRequest;
+
+export type PatchCentricPosOrderReceiptEmailResponse = Order;
+
+// GET /centric-pos/innovation/v1/digital-signage/orders/{stationId} - Get in-progress and ready orders for a station
+
+export interface GetDigitalSignageOrdersPath {
+	// Station identifier
+	stationId: string;
+}
+
+export interface GetDigitalSignageOrdersQuery {
+	// Number of minutes to show ready orders for (default: 15)
+	showReadyOrdersForMins?: number;
+	// IANA timezone name for start-of-day (e.g. America/New_York). Default: America/New_York
+	timezone?: string;
+	// Order type filter (pickup/delivery/frictionless/scan_and_go). Default: pickup
+	orderType?: Record<string, any>[];
+	// List of order statuses to be treated as in progress (created/accepted/in_progress/out_for_delivery). Default: in_progress
+	inProgressStatus?: Record<string, any>[];
+}
+
+export type GetDigitalSignageOrdersResponse = DigitalSignageOrdersResponse;

package/src/interface/centricos.ts

@@ -480,6 +480,51 @@ export interface ScanAndPaySectionDto {
 	canteen_location_id: string;
 }
 
+export interface FinancialSectionDto {
+	// Sales tax percentage. Send null to remove it; omit to leave it as is.
+	tax_rate_percent?: number | null;
+	// Service fee in dollars. Send null to remove it; omit to leave it as is.
+	service_fee?: number | null;
+	// JDE reporting category for the station
+	jde_category?: string;
+}
+
+export interface MenuDisclaimerDto {
+	// English disclaimer text
+	en?: string;
+	// French disclaimer text
+	fr?: string;
+}
+
+export interface OtherSectionDto {
+	// Address order notification emails go to. Send null to remove it; omit to leave it as is.
+	order_notification_email?: string | null;
+	// Menu calorie disclaimer, replaced as a whole. Send null to remove it; omit to leave it as is.
+	menu_disclaimer?: MenuDisclaimerDto;
+	// Whether guests can add special instructions to an order. Ignored for Just Walk Out stations.
+	special_instructions_enabled?: boolean;
+	// Whether the station is a dining hall. Ignored for Just Walk Out stations.
+	dining_hall_enabled?: boolean;
+}
+
+export interface ExcludedTenderDto {
+	// Tender number from the site mealplan setup
+	tender_number: string;
+	// Mealplan tender type the number belongs to
+	type: 'declining_balance' | 'meal_equivalent' | 'meal_exchange';
+}
+
+export interface PaymentExclusionsSectionDto {
+	// Whether credit cards are excluded
+	credit_card?: boolean;
+	// Digital wallets to exclude
+	digital_wallets?: ('apple_pay' | 'google_wallet')[];
+	// Cashless tender ids to exclude
+	cashless?: string[];
+	// Mealplan tenders to exclude
+	excluded_tenders?: ExcludedTenderDto[];
+}
+
 export interface JustWalkOutSectionDto {
 	// Whether the store is live. Drives frictionless_supported and pickup_supported.
 	enabled: boolean;
@@ -498,6 +543,12 @@ export interface PutStationIntegrationRequest {
 	drop_off?: DropOffSectionDto;
 	// Scan & Pay setup
 	scan_and_pay?: ScanAndPaySectionDto;
+	// Tax, service fee and reporting
+	financial?: FinancialSectionDto;
+	// Notification email, menu disclaimer and dining flags
+	other?: OtherSectionDto;
+	// Payment methods to exclude, replaced as a whole
+	payment_exclusions?: PaymentExclusionsSectionDto;
 	// Just Walk Out setup
 	just_walk_out?: JustWalkOutSectionDto;
 }

package/src/interface/menu.ts

@@ -2096,6 +2096,13 @@ export interface ReorderMenuItemDTO {
 	[index: string]: any;
 }
 
+export interface BulkGeneratedBarcodeDTO {
+	item_id: string;
+	barcode: string;
+	generated: boolean;
+	[index: string]: any;
+}
+
 export interface DraftModifierGroupEntityDTO {
 	parent?: DraftModifierGroupDTO;
 	children?: DraftModifierGroupDTO[];
@@ -8743,7 +8750,10 @@ export interface PostMenuV4BrandGenerateBarcodesBody {
 }
 
 export interface PostMenuV4BrandGenerateBarcodesResponse {
-	generated?: number;
+	generated: number;
+	items: BulkGeneratedBarcodeDTO[];
+	not_found: string[];
+	[index: string]: any;
 }
 
 export interface PostMenuV4BrandGenerateBarcodesRequest