@compassdigital/sdk.typescript 4.294.0 → 4.296.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/lib/index.d.ts +47 -7
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +47 -3
- package/lib/index.js.map +1 -1
- package/lib/interface/calendar.d.ts +26 -3
- package/lib/interface/calendar.d.ts.map +1 -1
- package/lib/interface/consumer.d.ts +141 -0
- package/lib/interface/consumer.d.ts.map +1 -1
- package/lib/interface/shoppingcart.d.ts +35 -0
- package/lib/interface/shoppingcart.d.ts.map +1 -1
- package/lib/messages/events/DiscountCreatedEvent.d.ts +3 -0
- package/lib/messages/events/DiscountCreatedEvent.d.ts.map +1 -1
- package/lib/messages/events/TaskDeletedEvent.d.ts +55 -3
- package/lib/messages/events/TaskDeletedEvent.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +121 -7
- package/src/interface/calendar.ts +37 -4
- package/src/interface/consumer.ts +157 -0
- package/src/interface/shoppingcart.ts +57 -0
- package/src/messages/events/DiscountCreatedEvent.ts +3 -0
- package/src/messages/events/TaskDeletedEvent.ts +94 -4
|
@@ -1,3 +1,57 @@
|
|
|
1
|
+
export interface Task {
|
|
2
|
+
id?: string;
|
|
3
|
+
order_id?: string;
|
|
4
|
+
shoppingcart_id?: string;
|
|
5
|
+
customer_id?: string;
|
|
6
|
+
location_id?: string;
|
|
7
|
+
location_type?: 'brand' | 'group';
|
|
8
|
+
order?: TaskOrder;
|
|
9
|
+
pickup_details?: TaskLocation;
|
|
10
|
+
dropoff_details?: TaskLocation;
|
|
11
|
+
status?: TaskStatus;
|
|
12
|
+
meta?: Record<string, any>;
|
|
13
|
+
created?: string;
|
|
14
|
+
expires?: string;
|
|
15
|
+
modified?: string;
|
|
16
|
+
scheduled_start?: string;
|
|
17
|
+
started?: string;
|
|
18
|
+
completed?: string;
|
|
19
|
+
assignee?: string;
|
|
20
|
+
type?: 'bolter' | 'kds';
|
|
21
|
+
}
|
|
22
|
+
export interface TaskOrder {
|
|
23
|
+
order_id?: string;
|
|
24
|
+
customer_id?: string;
|
|
25
|
+
customer?: {
|
|
26
|
+
name?: string;
|
|
27
|
+
contact_number?: string;
|
|
28
|
+
country_code?: string;
|
|
29
|
+
};
|
|
30
|
+
order_details?: {
|
|
31
|
+
order_type?: string;
|
|
32
|
+
duration?: string;
|
|
33
|
+
display_id?: string;
|
|
34
|
+
destination?: string;
|
|
35
|
+
};
|
|
36
|
+
delivery_instructions?: string;
|
|
37
|
+
[index: string]: any;
|
|
38
|
+
}
|
|
39
|
+
export interface TaskLocation {
|
|
40
|
+
location_id: string;
|
|
41
|
+
latitude: number;
|
|
42
|
+
longitude: number;
|
|
43
|
+
address: string;
|
|
44
|
+
action_time: string;
|
|
45
|
+
details?: Record<string, any>;
|
|
46
|
+
city?: string;
|
|
47
|
+
state?: string;
|
|
48
|
+
zip?: string;
|
|
49
|
+
country?: string;
|
|
50
|
+
information?: string;
|
|
51
|
+
foodlocker?: boolean;
|
|
52
|
+
[index: string]: any;
|
|
53
|
+
}
|
|
54
|
+
export type TaskStatus = 'new' | 'in_progress' | 'ready' | 'out_for_delivery' | 'delivered' | 'order_is_ready' | 'accepted' | 'cancelled';
|
|
1
55
|
export interface TaskDeletedEvent {
|
|
2
56
|
id: string;
|
|
3
57
|
type: 'TaskDeletedEvent';
|
|
@@ -7,9 +61,7 @@ export interface TaskDeletedEvent {
|
|
|
7
61
|
traceId?: string;
|
|
8
62
|
};
|
|
9
63
|
payload: {
|
|
10
|
-
task:
|
|
11
|
-
id: string;
|
|
12
|
-
};
|
|
64
|
+
task: Task;
|
|
13
65
|
};
|
|
14
66
|
source: string;
|
|
15
67
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TaskDeletedEvent.d.ts","sourceRoot":"","sources":["../../../src/messages/events/TaskDeletedEvent.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,gBAAgB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,kBAAkB,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,OAAO,EAAE;QACR,IAAI,EAAE
|
|
1
|
+
{"version":3,"file":"TaskDeletedEvent.d.ts","sourceRoot":"","sources":["../../../src/messages/events/TaskDeletedEvent.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,IAAI;IAEpB,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAClC,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,cAAc,CAAC,EAAE,YAAY,CAAC;IAC9B,eAAe,CAAC,EAAE,YAAY,CAAC;IAC/B,MAAM,CAAC,EAAE,UAAU,CAAC;IAEpB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE3B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,IAAI,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC;CACxB;AAED,MAAM,WAAW,SAAS;IACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE;QACV,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,YAAY,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,aAAa,CAAC,EAAE;QACf,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,WAAW,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAE5B,WAAW,EAAE,MAAM,CAAC;IAEpB,QAAQ,EAAE,MAAM,CAAC;IAEjB,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,MAAM,CAAC;IAEhB,WAAW,EAAE,MAAM,CAAC;IAEpB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE9B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CACrB;AAED,MAAM,MAAM,UAAU,GACnB,KAAK,GACL,aAAa,GACb,OAAO,GACP,kBAAkB,GAClB,WAAW,GACX,gBAAgB,GAChB,UAAU,GACV,WAAW,CAAC;AAEf,MAAM,WAAW,gBAAgB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,kBAAkB,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,OAAO,EAAE;QACR,IAAI,EAAE,IAAI,CAAC;KACX,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;CACf"}
|
package/package.json
CHANGED
package/src/index.ts
CHANGED
|
@@ -214,6 +214,10 @@ import {
|
|
|
214
214
|
PutShoppingcartCheckoutResponse,
|
|
215
215
|
PostShoppingcartBulkBody,
|
|
216
216
|
PostShoppingcartBulkResponse,
|
|
217
|
+
GetPingQuery,
|
|
218
|
+
GetPingResponse,
|
|
219
|
+
GetHealthQuery,
|
|
220
|
+
GetHealthResponse,
|
|
217
221
|
} from './interface/shoppingcart';
|
|
218
222
|
|
|
219
223
|
import {
|
|
@@ -479,8 +483,10 @@ import {
|
|
|
479
483
|
GetCalendarSwaggerQuery,
|
|
480
484
|
GetCalendarSwaggerResponse,
|
|
481
485
|
PostCalendarSyncResponse,
|
|
482
|
-
|
|
483
|
-
|
|
486
|
+
GetCalendarPingQuery,
|
|
487
|
+
GetCalendarPingResponse,
|
|
488
|
+
GetCalendarHealthQuery,
|
|
489
|
+
GetCalendarHealthResponse,
|
|
484
490
|
} from './interface/calendar';
|
|
485
491
|
|
|
486
492
|
import {
|
|
@@ -1218,6 +1224,10 @@ import {
|
|
|
1218
1224
|
GetConsumerShoppingcartResponse,
|
|
1219
1225
|
PutConsumerShoppingcartBody,
|
|
1220
1226
|
PutConsumerShoppingcartResponse,
|
|
1227
|
+
DeleteConsumerShoppingcartBody,
|
|
1228
|
+
DeleteConsumerShoppingcartResponse,
|
|
1229
|
+
PatchConsumerShoppingcartBody,
|
|
1230
|
+
PatchConsumerShoppingcartResponse,
|
|
1221
1231
|
PostConsumerShoppingcartRecommendedItemsBody,
|
|
1222
1232
|
PostConsumerShoppingcartRecommendedItemsResponse,
|
|
1223
1233
|
PostConsumerShoppingcartBody,
|
|
@@ -3443,6 +3453,46 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
3443
3453
|
);
|
|
3444
3454
|
}
|
|
3445
3455
|
|
|
3456
|
+
/**
|
|
3457
|
+
* GET /shoppingcart/ping - Service ping endpoint for basic connectivity check
|
|
3458
|
+
*
|
|
3459
|
+
* @param options - additional request options
|
|
3460
|
+
*/
|
|
3461
|
+
get_ping(
|
|
3462
|
+
options?: {
|
|
3463
|
+
query?: GetPingQuery;
|
|
3464
|
+
} & RequestOptions,
|
|
3465
|
+
): ResponsePromise<GetPingResponse> {
|
|
3466
|
+
return this.request(
|
|
3467
|
+
'shoppingcart',
|
|
3468
|
+
'/shoppingcart/ping',
|
|
3469
|
+
'GET',
|
|
3470
|
+
`/shoppingcart/ping`,
|
|
3471
|
+
null,
|
|
3472
|
+
options,
|
|
3473
|
+
);
|
|
3474
|
+
}
|
|
3475
|
+
|
|
3476
|
+
/**
|
|
3477
|
+
* GET /shoppingcart/health - Service health endpoint for dependency checks
|
|
3478
|
+
*
|
|
3479
|
+
* @param options - additional request options
|
|
3480
|
+
*/
|
|
3481
|
+
get_health(
|
|
3482
|
+
options?: {
|
|
3483
|
+
query?: GetHealthQuery;
|
|
3484
|
+
} & RequestOptions,
|
|
3485
|
+
): ResponsePromise<GetHealthResponse> {
|
|
3486
|
+
return this.request(
|
|
3487
|
+
'shoppingcart',
|
|
3488
|
+
'/shoppingcart/health',
|
|
3489
|
+
'GET',
|
|
3490
|
+
`/shoppingcart/health`,
|
|
3491
|
+
null,
|
|
3492
|
+
options,
|
|
3493
|
+
);
|
|
3494
|
+
}
|
|
3495
|
+
|
|
3446
3496
|
/**
|
|
3447
3497
|
* POST /partner/event/{id} - Send an event from 3rd party to our system
|
|
3448
3498
|
*
|
|
@@ -5670,16 +5720,36 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
5670
5720
|
}
|
|
5671
5721
|
|
|
5672
5722
|
/**
|
|
5673
|
-
* GET /ping - Service ping endpoint for basic connectivity check
|
|
5723
|
+
* GET /calendar/ping - Service ping endpoint for basic connectivity check
|
|
5674
5724
|
*
|
|
5675
5725
|
* @param options - additional request options
|
|
5676
5726
|
*/
|
|
5677
|
-
|
|
5727
|
+
get_calendar_ping(
|
|
5678
5728
|
options?: {
|
|
5679
|
-
query?:
|
|
5729
|
+
query?: GetCalendarPingQuery;
|
|
5680
5730
|
} & RequestOptions,
|
|
5681
|
-
): ResponsePromise<
|
|
5682
|
-
return this.request('calendar', '/ping', 'GET', `/ping`, null, options);
|
|
5731
|
+
): ResponsePromise<GetCalendarPingResponse> {
|
|
5732
|
+
return this.request('calendar', '/calendar/ping', 'GET', `/calendar/ping`, null, options);
|
|
5733
|
+
}
|
|
5734
|
+
|
|
5735
|
+
/**
|
|
5736
|
+
* GET /calendar/health - Service health endpoint for dependency checks
|
|
5737
|
+
*
|
|
5738
|
+
* @param options - additional request options
|
|
5739
|
+
*/
|
|
5740
|
+
get_calendar_health(
|
|
5741
|
+
options?: {
|
|
5742
|
+
query?: GetCalendarHealthQuery;
|
|
5743
|
+
} & RequestOptions,
|
|
5744
|
+
): ResponsePromise<GetCalendarHealthResponse> {
|
|
5745
|
+
return this.request(
|
|
5746
|
+
'calendar',
|
|
5747
|
+
'/calendar/health',
|
|
5748
|
+
'GET',
|
|
5749
|
+
`/calendar/health`,
|
|
5750
|
+
null,
|
|
5751
|
+
options,
|
|
5752
|
+
);
|
|
5683
5753
|
}
|
|
5684
5754
|
|
|
5685
5755
|
/**
|
|
@@ -13298,6 +13368,50 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
13298
13368
|
);
|
|
13299
13369
|
}
|
|
13300
13370
|
|
|
13371
|
+
/**
|
|
13372
|
+
* DELETE /consumer/shoppingcart/{id} - Delete a menu item from a ShoppingCart
|
|
13373
|
+
*
|
|
13374
|
+
* @param id
|
|
13375
|
+
* @param body - Post Shopping Cart Request Body
|
|
13376
|
+
* @param options - additional request options
|
|
13377
|
+
*/
|
|
13378
|
+
delete_consumer_shoppingcart(
|
|
13379
|
+
id: string,
|
|
13380
|
+
body: DeleteConsumerShoppingcartBody,
|
|
13381
|
+
options?: RequestOptions,
|
|
13382
|
+
): ResponsePromise<DeleteConsumerShoppingcartResponse> {
|
|
13383
|
+
return this.request(
|
|
13384
|
+
'consumer',
|
|
13385
|
+
'/consumer/shoppingcart/{id}',
|
|
13386
|
+
'DELETE',
|
|
13387
|
+
`/consumer/shoppingcart/${id}`,
|
|
13388
|
+
body,
|
|
13389
|
+
options,
|
|
13390
|
+
);
|
|
13391
|
+
}
|
|
13392
|
+
|
|
13393
|
+
/**
|
|
13394
|
+
* PATCH /consumer/shoppingcart/{id} - Patch a shopping cart by ID
|
|
13395
|
+
*
|
|
13396
|
+
* @param id - Shopping Cart ID as Encoded CDL ID; TODO: mark parameter as required in swagger
|
|
13397
|
+
* @param body
|
|
13398
|
+
* @param options - additional request options
|
|
13399
|
+
*/
|
|
13400
|
+
patch_consumer_shoppingcart(
|
|
13401
|
+
id: string,
|
|
13402
|
+
body: PatchConsumerShoppingcartBody,
|
|
13403
|
+
options?: RequestOptions,
|
|
13404
|
+
): ResponsePromise<PatchConsumerShoppingcartResponse> {
|
|
13405
|
+
return this.request(
|
|
13406
|
+
'consumer',
|
|
13407
|
+
'/consumer/shoppingcart/{id}',
|
|
13408
|
+
'PATCH',
|
|
13409
|
+
`/consumer/shoppingcart/${id}`,
|
|
13410
|
+
body,
|
|
13411
|
+
options,
|
|
13412
|
+
);
|
|
13413
|
+
}
|
|
13414
|
+
|
|
13301
13415
|
/**
|
|
13302
13416
|
* POST /consumer/shoppingcart/{id}/recommended - Get recommended items for a station or marketplace cart
|
|
13303
13417
|
*
|
|
@@ -103,6 +103,26 @@ export interface PingResponse {
|
|
|
103
103
|
service?: string;
|
|
104
104
|
}
|
|
105
105
|
|
|
106
|
+
export interface HealthResponse {
|
|
107
|
+
status?: 'healthy' | 'unhealthy';
|
|
108
|
+
timestamp?: string;
|
|
109
|
+
version?: string;
|
|
110
|
+
dependencies?: DependencyStatus[];
|
|
111
|
+
metadata?: HealthMetadata;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
export interface DependencyStatus {
|
|
115
|
+
name?: string;
|
|
116
|
+
status?: 'healthy' | 'unhealthy';
|
|
117
|
+
responseTimeMs?: number | null;
|
|
118
|
+
details?: string | null;
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
export interface HealthMetadata {
|
|
122
|
+
region?: string;
|
|
123
|
+
service?: string;
|
|
124
|
+
}
|
|
125
|
+
|
|
106
126
|
// GET /calendar/{id}
|
|
107
127
|
|
|
108
128
|
export interface GetCalendarPath {
|
|
@@ -196,13 +216,26 @@ export type PostCalendarSyncResponse = Success;
|
|
|
196
216
|
|
|
197
217
|
export interface PostCalendarSyncRequest extends BaseRequest, PostCalendarSyncPath {}
|
|
198
218
|
|
|
199
|
-
// GET /ping - Service ping endpoint for basic connectivity check
|
|
219
|
+
// GET /calendar/ping - Service ping endpoint for basic connectivity check
|
|
200
220
|
|
|
201
|
-
export interface
|
|
221
|
+
export interface GetCalendarPingQuery {
|
|
202
222
|
// Graphql query string
|
|
203
223
|
_query?: string;
|
|
204
224
|
}
|
|
205
225
|
|
|
206
|
-
export type
|
|
226
|
+
export type GetCalendarPingResponse = PingResponse;
|
|
207
227
|
|
|
208
|
-
export interface
|
|
228
|
+
export interface GetCalendarPingRequest extends BaseRequest, RequestQuery<GetCalendarPingQuery> {}
|
|
229
|
+
|
|
230
|
+
// GET /calendar/health - Service health endpoint for dependency checks
|
|
231
|
+
|
|
232
|
+
export interface GetCalendarHealthQuery {
|
|
233
|
+
// Graphql query string
|
|
234
|
+
_query?: string;
|
|
235
|
+
}
|
|
236
|
+
|
|
237
|
+
export type GetCalendarHealthResponse = HealthResponse;
|
|
238
|
+
|
|
239
|
+
export interface GetCalendarHealthRequest
|
|
240
|
+
extends BaseRequest,
|
|
241
|
+
RequestQuery<GetCalendarHealthQuery> {}
|
|
@@ -2690,6 +2690,142 @@ export interface PutConsumerShoppingCartPromoRequestDto {
|
|
|
2690
2690
|
email?: string;
|
|
2691
2691
|
}
|
|
2692
2692
|
|
|
2693
|
+
export interface DeleteConsumerShoppingcartCartItemsBody {
|
|
2694
|
+
// items
|
|
2695
|
+
items: ConsumerItemRequest[];
|
|
2696
|
+
}
|
|
2697
|
+
|
|
2698
|
+
export interface DeleteConsumerShoppingCartResponse {
|
|
2699
|
+
id?: string;
|
|
2700
|
+
location?: string;
|
|
2701
|
+
menu?: string;
|
|
2702
|
+
brand?: string;
|
|
2703
|
+
date?: Record<string, any>;
|
|
2704
|
+
items?: ShoppingcartItem[];
|
|
2705
|
+
sub_total?: {
|
|
2706
|
+
amount?: number;
|
|
2707
|
+
};
|
|
2708
|
+
promo?: ShoppingcartPromoDetails;
|
|
2709
|
+
discount?: ShoppingcartPromoDetails;
|
|
2710
|
+
discounts?: {
|
|
2711
|
+
stacked_total?: number;
|
|
2712
|
+
stacked_discounts?: Record<string, any>[];
|
|
2713
|
+
app?: string;
|
|
2714
|
+
};
|
|
2715
|
+
payment_method?: ShoppingcartPaymentMethod;
|
|
2716
|
+
taxes?: ShoppingcartTaxes;
|
|
2717
|
+
total?: {
|
|
2718
|
+
amount?: number;
|
|
2719
|
+
meals?: number;
|
|
2720
|
+
};
|
|
2721
|
+
exemptions?: {
|
|
2722
|
+
tax?: boolean;
|
|
2723
|
+
};
|
|
2724
|
+
order?: {
|
|
2725
|
+
id?: string;
|
|
2726
|
+
};
|
|
2727
|
+
service_fee?: {
|
|
2728
|
+
amount?: number;
|
|
2729
|
+
};
|
|
2730
|
+
delivery_fee?: {
|
|
2731
|
+
amount?: number;
|
|
2732
|
+
};
|
|
2733
|
+
is?: {
|
|
2734
|
+
type?: Record<string, any>;
|
|
2735
|
+
mx_cart?: boolean;
|
|
2736
|
+
email_tax_exempt?: boolean;
|
|
2737
|
+
tax_calculation_required?: boolean;
|
|
2738
|
+
system365?: boolean;
|
|
2739
|
+
};
|
|
2740
|
+
incentives?: ConsumerIncentives;
|
|
2741
|
+
}
|
|
2742
|
+
|
|
2743
|
+
export interface PatchConsumerShoppingCartRequest {
|
|
2744
|
+
id?: string;
|
|
2745
|
+
location?: string;
|
|
2746
|
+
menu?: string;
|
|
2747
|
+
brand?: string;
|
|
2748
|
+
date?: Record<string, any>;
|
|
2749
|
+
items?: ShoppingcartItem[];
|
|
2750
|
+
sub_total?: {
|
|
2751
|
+
amount?: number;
|
|
2752
|
+
};
|
|
2753
|
+
promo?: PromoDetails;
|
|
2754
|
+
discount?: PromoDetails;
|
|
2755
|
+
discounts?: Discounts;
|
|
2756
|
+
payment_method?: ShoppingcartPaymentMethod;
|
|
2757
|
+
taxes?: ShoppingcartTaxes;
|
|
2758
|
+
total?: {
|
|
2759
|
+
amount?: number;
|
|
2760
|
+
meals?: number;
|
|
2761
|
+
};
|
|
2762
|
+
exemptions?: {
|
|
2763
|
+
tax?: boolean;
|
|
2764
|
+
};
|
|
2765
|
+
order?: {
|
|
2766
|
+
id?: string;
|
|
2767
|
+
};
|
|
2768
|
+
service_fee?: {
|
|
2769
|
+
amount?: number;
|
|
2770
|
+
};
|
|
2771
|
+
delivery_fee?: {
|
|
2772
|
+
amount?: number;
|
|
2773
|
+
};
|
|
2774
|
+
is?: {
|
|
2775
|
+
type?: Record<string, any>;
|
|
2776
|
+
mx_cart?: boolean;
|
|
2777
|
+
email_tax_exempt?: boolean;
|
|
2778
|
+
tax_calculation_required?: boolean;
|
|
2779
|
+
system365?: boolean;
|
|
2780
|
+
};
|
|
2781
|
+
incentives?: ConsumerIncentives;
|
|
2782
|
+
}
|
|
2783
|
+
|
|
2784
|
+
export interface PatchConsumerShoppingCartResponse {
|
|
2785
|
+
id?: string;
|
|
2786
|
+
location?: string;
|
|
2787
|
+
menu?: string;
|
|
2788
|
+
brand?: string;
|
|
2789
|
+
date?: Record<string, any>;
|
|
2790
|
+
items?: ShoppingcartItem[];
|
|
2791
|
+
sub_total?: {
|
|
2792
|
+
amount?: number;
|
|
2793
|
+
};
|
|
2794
|
+
promo?: ShoppingcartPromoDetails;
|
|
2795
|
+
discount?: ShoppingcartPromoDetails;
|
|
2796
|
+
discounts?: {
|
|
2797
|
+
stacked_total?: number;
|
|
2798
|
+
stacked_discounts?: Record<string, any>[];
|
|
2799
|
+
app?: string;
|
|
2800
|
+
};
|
|
2801
|
+
payment_method?: ShoppingcartPaymentMethod;
|
|
2802
|
+
taxes?: ShoppingcartTaxes;
|
|
2803
|
+
total?: {
|
|
2804
|
+
amount?: number;
|
|
2805
|
+
meals?: number;
|
|
2806
|
+
};
|
|
2807
|
+
exemptions?: {
|
|
2808
|
+
tax?: boolean;
|
|
2809
|
+
};
|
|
2810
|
+
order?: {
|
|
2811
|
+
id?: string;
|
|
2812
|
+
};
|
|
2813
|
+
service_fee?: {
|
|
2814
|
+
amount?: number;
|
|
2815
|
+
};
|
|
2816
|
+
delivery_fee?: {
|
|
2817
|
+
amount?: number;
|
|
2818
|
+
};
|
|
2819
|
+
is?: {
|
|
2820
|
+
type?: Record<string, any>;
|
|
2821
|
+
mx_cart?: boolean;
|
|
2822
|
+
email_tax_exempt?: boolean;
|
|
2823
|
+
tax_calculation_required?: boolean;
|
|
2824
|
+
system365?: boolean;
|
|
2825
|
+
};
|
|
2826
|
+
incentives?: ConsumerIncentives;
|
|
2827
|
+
}
|
|
2828
|
+
|
|
2693
2829
|
// GET /consumer/v1/health-check
|
|
2694
2830
|
|
|
2695
2831
|
export interface HealthCheckControllerExecuteQuery {
|
|
@@ -3030,6 +3166,27 @@ export type PutConsumerShoppingcartBody = PutConsumerShoppingCartItemsRequest;
|
|
|
3030
3166
|
|
|
3031
3167
|
export type PutConsumerShoppingcartResponse = PutConsumerShoppingCartResponse;
|
|
3032
3168
|
|
|
3169
|
+
// DELETE /consumer/shoppingcart/{id} - Delete a menu item from a ShoppingCart
|
|
3170
|
+
|
|
3171
|
+
export interface DeleteConsumerShoppingcartPath {
|
|
3172
|
+
id: string;
|
|
3173
|
+
}
|
|
3174
|
+
|
|
3175
|
+
export type DeleteConsumerShoppingcartBody = DeleteConsumerShoppingcartCartItemsBody;
|
|
3176
|
+
|
|
3177
|
+
export type DeleteConsumerShoppingcartResponse = DeleteConsumerShoppingCartResponse;
|
|
3178
|
+
|
|
3179
|
+
// PATCH /consumer/shoppingcart/{id} - Patch a shopping cart by ID
|
|
3180
|
+
|
|
3181
|
+
export interface PatchConsumerShoppingcartPath {
|
|
3182
|
+
// Shopping Cart ID as Encoded CDL ID; TODO: mark parameter as required in swagger
|
|
3183
|
+
id: string;
|
|
3184
|
+
}
|
|
3185
|
+
|
|
3186
|
+
export type PatchConsumerShoppingcartBody = PatchConsumerShoppingCartRequest;
|
|
3187
|
+
|
|
3188
|
+
export type PatchConsumerShoppingcartResponse = PatchConsumerShoppingCartResponse;
|
|
3189
|
+
|
|
3033
3190
|
// POST /consumer/shoppingcart/{id}/recommended - Get recommended items for a station or marketplace cart
|
|
3034
3191
|
|
|
3035
3192
|
export interface PostConsumerShoppingcartRecommendedItemsPath {
|
|
@@ -705,6 +705,41 @@ export interface ItemReporting {
|
|
|
705
705
|
menu_brand_jde_category?: string;
|
|
706
706
|
}
|
|
707
707
|
|
|
708
|
+
export interface PingResponse {
|
|
709
|
+
status?: string;
|
|
710
|
+
message?: string;
|
|
711
|
+
timestamp?: string;
|
|
712
|
+
service?: string;
|
|
713
|
+
}
|
|
714
|
+
|
|
715
|
+
export interface HealthResponse {
|
|
716
|
+
// Overall health status of the service
|
|
717
|
+
status: 'healthy' | 'unhealthy' | 'degraded';
|
|
718
|
+
// ISO timestamp of the health check
|
|
719
|
+
timestamp: string;
|
|
720
|
+
// Service version
|
|
721
|
+
version: string;
|
|
722
|
+
// Status of service dependencies
|
|
723
|
+
dependencies: HealthDependency[];
|
|
724
|
+
metadata: HealthMetadata;
|
|
725
|
+
}
|
|
726
|
+
|
|
727
|
+
export interface HealthDependency {
|
|
728
|
+
// Name of the dependency
|
|
729
|
+
name: string;
|
|
730
|
+
// Health status of the dependency
|
|
731
|
+
status: 'healthy' | 'unhealthy' | 'degraded';
|
|
732
|
+
// Response time in milliseconds
|
|
733
|
+
responseTimeMs: number;
|
|
734
|
+
// Additional details about the dependency status
|
|
735
|
+
details: string | null;
|
|
736
|
+
}
|
|
737
|
+
|
|
738
|
+
export interface HealthMetadata {
|
|
739
|
+
region?: string;
|
|
740
|
+
service?: string;
|
|
741
|
+
}
|
|
742
|
+
|
|
708
743
|
// POST /shoppingcart - Create a new ShoppingCart
|
|
709
744
|
|
|
710
745
|
export interface PostShoppingcartCartQuery {
|
|
@@ -925,3 +960,25 @@ export type PostShoppingcartBulkResponse = ShoppingCarts;
|
|
|
925
960
|
export interface PostShoppingcartBulkRequest extends BaseRequest {
|
|
926
961
|
body: PostShoppingcartBulkBody;
|
|
927
962
|
}
|
|
963
|
+
|
|
964
|
+
// GET /shoppingcart/ping - Service ping endpoint for basic connectivity check
|
|
965
|
+
|
|
966
|
+
export interface GetPingQuery {
|
|
967
|
+
// Graphql query string
|
|
968
|
+
_query?: string;
|
|
969
|
+
}
|
|
970
|
+
|
|
971
|
+
export type GetPingResponse = PingResponse;
|
|
972
|
+
|
|
973
|
+
export interface GetPingRequest extends BaseRequest, RequestQuery<GetPingQuery> {}
|
|
974
|
+
|
|
975
|
+
// GET /shoppingcart/health - Service health endpoint for dependency checks
|
|
976
|
+
|
|
977
|
+
export interface GetHealthQuery {
|
|
978
|
+
// Graphql query string
|
|
979
|
+
_query?: string;
|
|
980
|
+
}
|
|
981
|
+
|
|
982
|
+
export type GetHealthResponse = HealthResponse;
|
|
983
|
+
|
|
984
|
+
export interface GetHealthRequest extends BaseRequest, RequestQuery<GetHealthQuery> {}
|
|
@@ -1,5 +1,98 @@
|
|
|
1
1
|
// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
|
|
2
2
|
|
|
3
|
+
export interface Task {
|
|
4
|
+
// task id
|
|
5
|
+
id?: string;
|
|
6
|
+
// order id
|
|
7
|
+
order_id?: string;
|
|
8
|
+
// shoppingcart id
|
|
9
|
+
shoppingcart_id?: string;
|
|
10
|
+
// customer id
|
|
11
|
+
customer_id?: string;
|
|
12
|
+
// location id for this task
|
|
13
|
+
location_id?: string;
|
|
14
|
+
// type of location id
|
|
15
|
+
location_type?: 'brand' | 'group';
|
|
16
|
+
order?: TaskOrder;
|
|
17
|
+
pickup_details?: TaskLocation;
|
|
18
|
+
dropoff_details?: TaskLocation;
|
|
19
|
+
status?: TaskStatus;
|
|
20
|
+
// Any related metadata information about this Task
|
|
21
|
+
meta?: Record<string, any>;
|
|
22
|
+
// Date when Task was created
|
|
23
|
+
created?: string;
|
|
24
|
+
// Date when Task expires
|
|
25
|
+
expires?: string;
|
|
26
|
+
// Date when task was last modified
|
|
27
|
+
modified?: string;
|
|
28
|
+
// Date when Task is scheduled to start
|
|
29
|
+
scheduled_start?: string;
|
|
30
|
+
// Date when task is out for delivery
|
|
31
|
+
started?: string;
|
|
32
|
+
// Date when task was delivered
|
|
33
|
+
completed?: string;
|
|
34
|
+
// runner id
|
|
35
|
+
assignee?: string;
|
|
36
|
+
// Task Type
|
|
37
|
+
type?: 'bolter' | 'kds';
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
export interface TaskOrder {
|
|
41
|
+
order_id?: string;
|
|
42
|
+
customer_id?: string;
|
|
43
|
+
customer?: {
|
|
44
|
+
name?: string;
|
|
45
|
+
contact_number?: string;
|
|
46
|
+
country_code?: string;
|
|
47
|
+
};
|
|
48
|
+
order_details?: {
|
|
49
|
+
order_type?: string;
|
|
50
|
+
duration?: string;
|
|
51
|
+
display_id?: string;
|
|
52
|
+
destination?: string;
|
|
53
|
+
};
|
|
54
|
+
delivery_instructions?: string;
|
|
55
|
+
[index: string]: any;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
export interface TaskLocation {
|
|
59
|
+
// Location ID
|
|
60
|
+
location_id: string;
|
|
61
|
+
// Location latitude
|
|
62
|
+
latitude: number;
|
|
63
|
+
// Location Longitude
|
|
64
|
+
longitude: number;
|
|
65
|
+
// Location Address
|
|
66
|
+
address: string;
|
|
67
|
+
// Pickup or Dropoff time
|
|
68
|
+
action_time: string;
|
|
69
|
+
// optional details
|
|
70
|
+
details?: Record<string, any>;
|
|
71
|
+
// City
|
|
72
|
+
city?: string;
|
|
73
|
+
// State
|
|
74
|
+
state?: string;
|
|
75
|
+
// ZIP code
|
|
76
|
+
zip?: string;
|
|
77
|
+
// Country
|
|
78
|
+
country?: string;
|
|
79
|
+
// Additional information
|
|
80
|
+
information?: string;
|
|
81
|
+
// Whether this is a foodlocker location
|
|
82
|
+
foodlocker?: boolean;
|
|
83
|
+
[index: string]: any;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
export type TaskStatus =
|
|
87
|
+
| 'new'
|
|
88
|
+
| 'in_progress'
|
|
89
|
+
| 'ready'
|
|
90
|
+
| 'out_for_delivery'
|
|
91
|
+
| 'delivered'
|
|
92
|
+
| 'order_is_ready'
|
|
93
|
+
| 'accepted'
|
|
94
|
+
| 'cancelled';
|
|
95
|
+
|
|
3
96
|
export interface TaskDeletedEvent {
|
|
4
97
|
id: string;
|
|
5
98
|
type: 'TaskDeletedEvent';
|
|
@@ -9,10 +102,7 @@ export interface TaskDeletedEvent {
|
|
|
9
102
|
traceId?: string;
|
|
10
103
|
};
|
|
11
104
|
payload: {
|
|
12
|
-
task:
|
|
13
|
-
// task id
|
|
14
|
-
id: string;
|
|
15
|
-
};
|
|
105
|
+
task: Task;
|
|
16
106
|
};
|
|
17
107
|
source: string;
|
|
18
108
|
}
|