@compassdigital/sdk.typescript 4.738.0 → 4.740.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/src/index.ts CHANGED
@@ -1219,6 +1219,8 @@ import {
1219
1219
  GetConsumerHomePageResponse,
1220
1220
  GetConsumerHomePageV2Query,
1221
1221
  GetConsumerHomePageV2Response,
1222
+ GetConsumerHomePageV3Query,
1223
+ GetConsumerHomePageV3Response,
1222
1224
  GetConsumerFrictionlessCheckinResponse,
1223
1225
  PostFrictionlessQrcodeBody,
1224
1226
  PostFrictionlessQrcodeResponse,
@@ -14127,6 +14129,28 @@ export class ServiceClient extends BaseServiceClient {
14127
14129
  );
14128
14130
  }
14129
14131
 
14132
+ /**
14133
+ * GET /consumer/v3/home/{siteId} - Provide the front end all the data required to render the home page
14134
+ *
14135
+ * @param siteId - Site ID as Encoded CDL ID
14136
+ * @param options - additional request options
14137
+ */
14138
+ get_consumer_home_page_v3(
14139
+ siteId: string,
14140
+ options: {
14141
+ query: GetConsumerHomePageV3Query;
14142
+ } & RequestOptions,
14143
+ ): ResponsePromise<GetConsumerHomePageV3Response> {
14144
+ return this.request(
14145
+ 'consumer',
14146
+ '/consumer/v3/home/{siteId}',
14147
+ 'GET',
14148
+ `/consumer/v3/home/${siteId}`,
14149
+ null,
14150
+ options,
14151
+ );
14152
+ }
14153
+
14130
14154
  /**
14131
14155
  * GET /consumer/frictionless/checkin/{id} - Allow a user to check in to a location using frictionless technology
14132
14156
  *
@@ -4524,88 +4524,11 @@ export interface GetConsumerLocationResponse {
4524
4524
  address?: ConsumerAddress;
4525
4525
  }
4526
4526
 
4527
- export interface LocationDto {
4528
- // Street address
4529
- address?: string;
4530
- // External identifier for the location
4531
- extId?: string;
4532
- // Latitude
4533
- lat?: number;
4534
- // Longitude
4535
- lon?: number;
4536
- }
4537
-
4538
- export interface EtaDto {
4539
- // Estimated drop-off time
4540
- dropOff?: string;
4541
- // Estimated pick-up time
4542
- pickUp?: string;
4543
- // Estimated return time
4544
- return?: string;
4545
- }
4546
-
4547
- export interface RequestLocationDto {
4548
- // Street address
4549
- address: string;
4550
- }
4551
-
4552
- export interface RequestDto {
4553
- // Client name
4554
- clientName?: string;
4555
- // Destination location
4556
- dst?: RequestLocationDto;
4557
- // Source location
4558
- src?: RequestLocationDto;
4559
- }
4560
-
4561
- export interface RobotPositionDto {
4562
- // Latitude
4563
- lat: number;
4564
- // Longitude
4565
- lon: number;
4566
- // Heading, in degrees
4567
- yaw: number;
4568
- }
4569
-
4570
- export interface RoutePointDto {
4571
- // Latitude
4572
- lat: number;
4573
- // Longitude
4574
- lon: number;
4575
- }
4576
-
4577
- export interface RobotDto {
4578
- // Whether the robot is delivering other orders
4579
- deliveringOtherOrders?: boolean;
4580
- // Robot name
4581
- name?: string;
4582
- // Robot position
4583
- position?: RobotPositionDto;
4584
- // Robot route
4585
- route?: RoutePointDto[];
4586
- }
4587
-
4588
4527
  export interface OrderOpenCloseLidResponseDto {
4589
- // Order creation time
4590
- createdAt?: string;
4591
- // Destination location
4592
- dst?: LocationDto;
4593
- // Estimated times
4594
- eta?: EtaDto;
4595
- // External identifier for the order
4596
- extId?: string;
4597
4528
  // Order identifier
4598
4529
  id: string;
4599
4530
  // Whether the lid is ready to be opened
4600
4531
  ready: boolean;
4601
- // Request details
4602
- request?: RequestDto;
4603
- // Robots involved
4604
- robots?: RobotDto[];
4605
- // Scheduled pick-up time
4606
- scheduledPickUp?: string;
4607
- // Source location
4608
- src?: LocationDto;
4609
4532
  // Order status
4610
4533
  status: string;
4611
4534
  }
@@ -4744,6 +4667,30 @@ export interface GetConsumerHomePageV2Query {
4744
4667
 
4745
4668
  export type GetConsumerHomePageV2Response = HomePageResponse;
4746
4669
 
4670
+ // GET /consumer/v3/home/{siteId} - Provide the front end all the data required to render the home page
4671
+
4672
+ export interface GetConsumerHomePageV3Path {
4673
+ // Site ID as Encoded CDL ID
4674
+ siteId: string;
4675
+ }
4676
+
4677
+ export interface GetConsumerHomePageV3Query {
4678
+ // order start time in epoch time
4679
+ start: number;
4680
+ // order end time in epoch time
4681
+ end: number;
4682
+ // current date in epoch time
4683
+ date: number;
4684
+ location_multigroup_id: string;
4685
+ timezoneOffset: string;
4686
+ // app name
4687
+ appName?: string;
4688
+ // reorder eligible
4689
+ reorderEligible: boolean;
4690
+ }
4691
+
4692
+ export type GetConsumerHomePageV3Response = HomePageResponse;
4693
+
4747
4694
  // GET /consumer/frictionless/checkin/{id} - Allow a user to check in to a location using frictionless technology
4748
4695
 
4749
4696
  export interface GetConsumerFrictionlessCheckinPath {
@@ -278,6 +278,8 @@ export interface Order {
278
278
  type_of_kds?: string;
279
279
  // Indicate whether the order is eligible for cancellation
280
280
  cancel_eligible?: boolean;
281
+ // Whether this order should produce a KDS task
282
+ requires_kds_task?: boolean;
281
283
  pickup_instruction?: MultiLanguageLabel;
282
284
  market_place_label?: MultiLanguageLabel;
283
285
  market_place_description?: MultiLanguageLabel;