@compassdigital/sdk.typescript 4.742.0 → 4.744.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@compassdigital/sdk.typescript",
3
- "version": "4.742.0",
3
+ "version": "4.744.0",
4
4
  "description": "Compass Digital Labs TypeScript SDK",
5
5
  "type": "commonjs",
6
6
  "main": "./lib/index.js",
package/src/index.ts CHANGED
@@ -1344,6 +1344,7 @@ import {
1344
1344
  GetConsumerUserMealplanBarcodeResponse,
1345
1345
  GetConsumerLocationQuery,
1346
1346
  GetConsumerLocationResponse$0,
1347
+ GetConsumerDeliveryResponse,
1347
1348
  PostConsumerDeliveryOrderOpenLidResponse,
1348
1349
  PostConsumerDeliveryOrderCloseLidResponse,
1349
1350
  } from './interface/consumer';
@@ -15629,6 +15630,26 @@ export class ServiceClient extends BaseServiceClient {
15629
15630
  );
15630
15631
  }
15631
15632
 
15633
+ /**
15634
+ * GET /consumer/delivery/{orderId} - Get guest-facing delivery status and ETAs for an order
15635
+ *
15636
+ * @param orderId - a valid CDL order id
15637
+ * @param options - additional request options
15638
+ */
15639
+ get_consumer_delivery(
15640
+ orderId: string,
15641
+ options?: RequestOptions,
15642
+ ): ResponsePromise<GetConsumerDeliveryResponse> {
15643
+ return this.request(
15644
+ 'consumer',
15645
+ '/consumer/delivery/{orderId}',
15646
+ 'GET',
15647
+ `/consumer/delivery/${orderId}`,
15648
+ null,
15649
+ options,
15650
+ );
15651
+ }
15652
+
15632
15653
  /**
15633
15654
  * POST /consumer/delivery/order/{id}/open - Open the lid of a delivery order
15634
15655
  *
@@ -379,6 +379,7 @@ export interface Integration {
379
379
  label: string;
380
380
  is_integrated: boolean;
381
381
  is_enabled: boolean;
382
+ is_visible: boolean;
382
383
  can_enable: boolean;
383
384
  content: Content;
384
385
  }
@@ -4524,6 +4524,29 @@ export interface GetConsumerLocationResponse {
4524
4524
  address?: ConsumerAddress;
4525
4525
  }
4526
4526
 
4527
+ export interface GetDeliveryOrderResponseDto {
4528
+ // CDL order id
4529
+ orderId: string;
4530
+ // Human-readable order number
4531
+ orderNumber: string;
4532
+ // Guest-facing delivery status
4533
+ status: string;
4534
+ // ETA timestamp for the current status, when applicable
4535
+ etaAt?: string | null;
4536
+ // Station pick-up location
4537
+ pickUp?: Record<string, any> | null;
4538
+ // Guest's drop-off location
4539
+ dropOff?: Record<string, any> | null;
4540
+ // When the robot reached drop-off
4541
+ dropOffArrivedAt?: string | null;
4542
+ // dropOffArrivedAt plus delivery discard wait time
4543
+ leaveTimeAt?: string | null;
4544
+ // Assigned robot; null once the delivery is terminal
4545
+ robot?: Record<string, any> | null;
4546
+ // Last time this record changed
4547
+ updatedAt: string;
4548
+ }
4549
+
4527
4550
  export interface OrderOpenCloseLidResponseDto {
4528
4551
  // Order identifier
4529
4552
  id: string;
@@ -5466,6 +5489,15 @@ export interface GetConsumerLocationQuery {
5466
5489
 
5467
5490
  export type GetConsumerLocationResponse$0 = GetConsumerLocationResponse;
5468
5491
 
5492
+ // GET /consumer/delivery/{orderId} - Get guest-facing delivery status and ETAs for an order
5493
+
5494
+ export interface GetConsumerDeliveryPath {
5495
+ // a valid CDL order id
5496
+ orderId: string;
5497
+ }
5498
+
5499
+ export type GetConsumerDeliveryResponse = GetDeliveryOrderResponseDto;
5500
+
5469
5501
  // POST /consumer/delivery/order/{id}/open - Open the lid of a delivery order
5470
5502
 
5471
5503
  export interface PostConsumerDeliveryOrderOpenLidPath {