@compassdigital/sdk.typescript 4.898.0 → 4.900.0

package/src/interface/centric-pos.ts

@@ -256,6 +256,47 @@ export interface PostOrderReceiptRequest {
 	receiptEmail: string;
 }
 
+export interface CentricPOSDeviceStation {
+	// Station (brand) ID
+	id: string;
+	// Station name
+	name?: string;
+	// Whether the station is hidden on this device
+	hidden: boolean;
+	// Whether the station can take orders: it has payment credentials or is a no-payment station
+	orderable: boolean;
+}
+
+export interface CentricPOSDevice {
+	// Serial number of the device
+	serialNumber: string;
+	// Site the device is registered at
+	siteId: string;
+	// Whether the device holds a login
+	registered: boolean;
+	// Whether the device's location is at its site and it shows at least one orderable station
+	complete: boolean;
+	// Location saved for the device
+	locationId?: string;
+	// Name of the device's location
+	locationName?: string;
+	// Merchant name set on the device's location
+	merchantName?: string;
+	// Centric POS stations at the device's location, with whether each is hidden
+	stations: CentricPOSDeviceStation[];
+}
+
+export interface CentricPOSSiteDevicesResponse {
+	devices: CentricPOSDevice[];
+}
+
+export interface CentricPOSDeviceSettingsPutBody {
+	// Location at the device's site
+	locationId: string;
+	// Stations at the location to hide on the device
+	hiddenStationIds: string[];
+}
+
 export interface DigitalSignageOrder {
 	// Display ID for the order
 	displayId: string;
@@ -337,6 +378,44 @@ export type PostCentricPosOrderReceiptBody = PostOrderReceiptRequest;
 
 export type PostCentricPosOrderReceiptResponse = {};
 
+// GET /centric-pos/v1/admin/site/{siteId}/devices - List a site's POS devices with their settings
+
+export interface GetCentricPosAdminSiteDevicesPath {
+	// Site (location group) identifier
+	siteId: string;
+}
+
+export type GetCentricPosAdminSiteDevicesResponse = CentricPOSSiteDevicesResponse;
+
+// GET /centric-pos/v1/admin/device/{serialNumber} - Get a POS device with its settings
+
+export interface GetCentricPosAdminDevicePath {
+	// Serial number of the device
+	serialNumber: string;
+}
+
+export type GetCentricPosAdminDeviceResponse = CentricPOSDevice;
+
+// PUT /centric-pos/v1/admin/device/{serialNumber}/settings - Save a POS device's location and hidden stations
+
+export interface PutCentricPosAdminDeviceSettingsPath {
+	// Serial number of the device
+	serialNumber: string;
+}
+
+export type PutCentricPosAdminDeviceSettingsBody = CentricPOSDeviceSettingsPutBody;
+
+export type PutCentricPosAdminDeviceSettingsResponse = CentricPOSDevice;
+
+// DELETE /centric-pos/v1/admin/device/{serialNumber}/settings - Clear a POS device's settings without unregistering it
+
+export interface DeleteCentricPosAdminDeviceSettingsPath {
+	// Serial number of the device
+	serialNumber: string;
+}
+
+export type DeleteCentricPosAdminDeviceSettingsResponse = {};
+
 // GET /centric-pos/innovation/v1/digital-signage/orders/{stationId} - Get in-progress and ready orders for a station
 
 export interface GetCentricPosDigitalSignageOrdersPath {

package/src/interface/delivery.ts

@@ -52,11 +52,26 @@ export interface GetDeliveryOrderResponseDto {
 		| 'pending'
 		| 'assigned'
 		| 'out_for_delivery'
-		| 'arrived'
 		| 'delivered'
+		| 'collected'
 		| 'returning'
 		| 'no_show'
 		| 'cancelled';
+	// Raw AVride order status; the robot lid is open on pickUpTransaction and dropOffTransaction
+	partnerStatus:
+		| 'new'
+		| 'accepted'
+		| 'pickUp'
+		| 'pickUpTransaction'
+		| 'transporting'
+		| 'dropOff'
+		| 'dropOffTransaction'
+		| 'completed'
+		| 'returnTransporting'
+		| 'returnDropOff'
+		| 'returnTransaction'
+		| 'returnCompleted'
+		| 'canceled';
 	// ETA timestamp for the current status, when applicable
 	etaAt?: string | null;
 	// Station pick-up location