@compassdigital/sdk.typescript 4.722.0 → 4.724.0

package/package.json

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

package/src/index.ts

@@ -1597,6 +1597,7 @@ import {
 
 import {
 	GetDeliveryHealthResponse,
+	GetDeliveryOrderResponse,
 	PostDeliveryOrderReadyResponse,
 	PostDeliveryOrderOpenLidResponse,
 	PostDeliveryOrderCloseLidResponse,
@@ -18189,6 +18190,26 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * GET /delivery/order/{id} - Get guest-facing delivery status and ETAs for an order
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	get_delivery_order(
+		id: string,
+		options?: RequestOptions,
+	): ResponsePromise<GetDeliveryOrderResponse> {
+		return this.request(
+			'delivery',
+			'/delivery/order/{id}',
+			'GET',
+			`/delivery/order/${id}`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * POST /delivery/order/{id}/ready - Mark an AVRIDE order ready for robot pickup
 	 *

package/src/interface/delivery.ts

@@ -20,13 +20,57 @@ export interface HealthResponseDto {
 	metadata: HealthMetadataDto;
 }
 
-export interface OrderReadyResponseDto {
-	// AVRIDE order id (same as the CDL order id)
-	id: string;
-	// AVRIDE order status after the ready call
-	status: string;
-	// Whether AVRIDE confirmed the order as ready
-	ready?: boolean;
+export interface GetDeliveryOrderLocationDto {
+	// Street address
+	address?: string;
+	// Latitude
+	lat: number;
+	// Longitude
+	lon: number;
+}
+
+export interface GetDeliveryOrderRobotPositionDto {
+	// Latitude
+	lat: number;
+	// Longitude
+	lon: number;
+}
+
+export interface GetDeliveryOrderRobotDto {
+	// Robot name
+	name: string;
+	position: GetDeliveryOrderRobotPositionDto;
+}
+
+export interface GetDeliveryOrderResponseDto {
+	// CDL order id
+	orderId: string;
+	// Human-readable order number
+	orderNumber: string;
+	// Guest-facing delivery status
+	status:
+		| 'pending'
+		| 'assigned'
+		| 'out_for_delivery'
+		| 'arrived'
+		| 'delivered'
+		| 'returning'
+		| 'no_show'
+		| 'cancelled';
+	// ETA timestamp for the current status, when applicable
+	etaAt?: Record<string, any> | null;
+	// Station pick-up location
+	pickUp?: GetDeliveryOrderLocationDto;
+	// Guest's drop-off location
+	dropOff?: GetDeliveryOrderLocationDto;
+	// When the robot reached drop-off
+	dropOffArrivedAt?: Record<string, any> | null;
+	// dropOffArrivedAt plus delivery discard wait time
+	leaveTimeAt?: Record<string, any> | null;
+	// Assigned robot; null once the delivery is terminal
+	robot?: GetDeliveryOrderRobotDto;
+	// Last time this record changed
+	updatedAt: string;
 }
 
 export interface ErrorDisplayMessage {
@@ -55,6 +99,15 @@ export interface Error {
 	data: ErrorData;
 }
 
+export interface OrderReadyResponseDto {
+	// AVRIDE order id (same as the CDL order id)
+	id: string;
+	// AVRIDE order status after the ready call
+	status: string;
+	// Whether AVRIDE confirmed the order as ready
+	ready?: boolean;
+}
+
 export interface LocationDto {
 	// Street address
 	address?: string;
@@ -236,6 +289,16 @@ export type GetDeliveryHealthResponse = HealthResponseDto;
 
 export interface GetDeliveryHealthRequest extends BaseRequest {}
 
+// GET /delivery/order/{id} - Get guest-facing delivery status and ETAs for an order
+
+export interface GetDeliveryOrderPath {
+	id: string;
+}
+
+export type GetDeliveryOrderResponse = GetDeliveryOrderResponseDto;
+
+export interface GetDeliveryOrderRequest extends BaseRequest, GetDeliveryOrderPath {}
+
 // POST /delivery/order/{id}/ready - Mark an AVRIDE order ready for robot pickup
 
 export interface PostDeliveryOrderReadyPath {

package/src/interface/menu.ts

@@ -735,6 +735,7 @@ export interface LocalMenuGroupDTO {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	strip_hidden_from_v2_payload?: boolean;
 	visibility?: Record<string, any>;
 	id: string;
 	created_at?: string;
@@ -2855,6 +2856,7 @@ export interface PostMenuV3LocalMenuGroupBody {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	strip_hidden_from_v2_payload?: boolean;
 	visibility?: Record<string, any>;
 	vendor_metadata?: VendorMetadataDTO[];
 	permissions?: Record<string, any>;
@@ -2871,6 +2873,7 @@ export interface PostMenuV3LocalMenuGroupResponse {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	strip_hidden_from_v2_payload?: boolean;
 	visibility?: Record<string, any>;
 	id: string;
 	created_at?: string;
@@ -2913,6 +2916,7 @@ export interface GetMenuV3LocalMenuGroupResponse {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	strip_hidden_from_v2_payload?: boolean;
 	visibility?: Record<string, any>;
 	id: string;
 	created_at?: string;
@@ -2945,6 +2949,7 @@ export interface PatchMenuV3LocalMenuGroupBody {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	strip_hidden_from_v2_payload?: boolean;
 	visibility?: Record<string, any>;
 	id?: string;
 	version?: number;
@@ -2963,6 +2968,7 @@ export interface PatchMenuV3LocalMenuGroupResponse {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	strip_hidden_from_v2_payload?: boolean;
 	visibility?: Record<string, any>;
 	id: string;
 	created_at?: string;
@@ -3001,6 +3007,7 @@ export interface DeleteMenuV3LocalMenuGroupResponse {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	strip_hidden_from_v2_payload?: boolean;
 	visibility?: Record<string, any>;
 	id: string;
 	created_at?: string;
@@ -3058,6 +3065,7 @@ export type PostMenuV3LocalMenuGroupsBody = {
 	show_v4?: boolean;
 	menuworks_unit_ids?: string[];
 	append_ingredients_nutrition_to_description?: boolean;
+	strip_hidden_from_v2_payload?: boolean;
 	visibility?: Record<string, any>;
 	vendor_metadata?: VendorMetadataDTO[];
 	permissions?: Record<string, any>;