@compassdigital/sdk.typescript 3.39.0 → 3.40.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.
Files changed (62) hide show
  1. package/lib/base.d.ts +3 -3
  2. package/lib/base.d.ts.map +1 -1
  3. package/lib/index.d.ts +11 -4
  4. package/lib/index.d.ts.map +1 -1
  5. package/lib/index.js +10 -3
  6. package/lib/index.js.map +1 -1
  7. package/lib/interface/announcement.d.ts +8 -8
  8. package/lib/interface/announcement.d.ts.map +1 -1
  9. package/lib/interface/calendar.d.ts +6 -6
  10. package/lib/interface/calendar.d.ts.map +1 -1
  11. package/lib/interface/compassconnect.d.ts +1 -1
  12. package/lib/interface/compassconnect.d.ts.map +1 -1
  13. package/lib/interface/config.d.ts +14 -14
  14. package/lib/interface/config.d.ts.map +1 -1
  15. package/lib/interface/datalake.d.ts +2 -2
  16. package/lib/interface/datalake.d.ts.map +1 -1
  17. package/lib/interface/email.d.ts +2 -2
  18. package/lib/interface/email.d.ts.map +1 -1
  19. package/lib/interface/file.d.ts +1 -1
  20. package/lib/interface/file.d.ts.map +1 -1
  21. package/lib/interface/kds.d.ts +7 -7
  22. package/lib/interface/kds.d.ts.map +1 -1
  23. package/lib/interface/location.d.ts +72 -70
  24. package/lib/interface/location.d.ts.map +1 -1
  25. package/lib/interface/loyalty.d.ts +11 -11
  26. package/lib/interface/loyalty.d.ts.map +1 -1
  27. package/lib/interface/mealplan.d.ts +8 -8
  28. package/lib/interface/mealplan.d.ts.map +1 -1
  29. package/lib/interface/menu.d.ts +44 -36
  30. package/lib/interface/menu.d.ts.map +1 -1
  31. package/lib/interface/notification.d.ts +7 -7
  32. package/lib/interface/notification.d.ts.map +1 -1
  33. package/lib/interface/order.d.ts +19 -16
  34. package/lib/interface/order.d.ts.map +1 -1
  35. package/lib/interface/partner.d.ts +452 -420
  36. package/lib/interface/partner.d.ts.map +1 -1
  37. package/lib/interface/payment.d.ts +12 -13
  38. package/lib/interface/payment.d.ts.map +1 -1
  39. package/lib/interface/permission.d.ts +14 -14
  40. package/lib/interface/permission.d.ts.map +1 -1
  41. package/lib/interface/promo.d.ts +25 -25
  42. package/lib/interface/promo.d.ts.map +1 -1
  43. package/lib/interface/report.d.ts +9 -9
  44. package/lib/interface/report.d.ts.map +1 -1
  45. package/lib/interface/shoppingcart.d.ts +20 -20
  46. package/lib/interface/shoppingcart.d.ts.map +1 -1
  47. package/lib/interface/task.d.ts +13 -13
  48. package/lib/interface/task.d.ts.map +1 -1
  49. package/lib/interface/user.d.ts +58 -44
  50. package/lib/interface/user.d.ts.map +1 -1
  51. package/lib/interface/util.d.ts +1 -1
  52. package/lib/interface/util.d.ts.map +1 -1
  53. package/lib/interface/vendor.d.ts +24 -24
  54. package/lib/interface/vendor.d.ts.map +1 -1
  55. package/package.json +1 -1
  56. package/src/index.ts +23 -4
  57. package/src/interface/location.ts +8 -6
  58. package/src/interface/menu.ts +15 -0
  59. package/src/interface/order.ts +4 -0
  60. package/src/interface/partner.ts +509 -469
  61. package/src/interface/payment.ts +2 -4
  62. package/src/interface/user.ts +15 -0
@@ -17,63 +17,7 @@ export interface ShoppingCart {
17
17
  // brand
18
18
  brand?: string;
19
19
  date?: any;
20
- items?: {
21
- // item
22
- id: string;
23
- // index
24
- _index?: string;
25
- quantity: number;
26
- unit?: number;
27
- price?: {
28
- amount?: number;
29
- };
30
- // Final item price after LTO/Bundle/BOGO etc is applied on the item.
31
- sale_price?: {
32
- active?: boolean;
33
- amount?: number;
34
- };
35
- // Subtotal of the item including all options
36
- _subtotal?: {
37
- amount?: number;
38
- };
39
- // Promo applied to this item
40
- _promo?: {
41
- amount?: number;
42
- };
43
- meta?: {
44
- // menu id
45
- menu?: string;
46
- // brand id
47
- brand?: string;
48
- [index: string]: any;
49
- };
50
- options?: {
51
- id?: string;
52
- label?: {
53
- en?: string;
54
- };
55
- meta?: any;
56
- items?: {
57
- // option
58
- id?: string;
59
- label?: {
60
- en?: string;
61
- };
62
- // index
63
- _index?: string;
64
- meta?: any;
65
- quantity?: number;
66
- amount_off_exclusions?: string[];
67
- }[];
68
- }[];
69
- // Details about discount like BOGO, LTO, Bundle etc.
70
- item_discount?: any;
71
- // user specified instructions for the item
72
- special_instructions?: string;
73
- amount_off_exclusions?: string[];
74
- added_on?: string;
75
- [index: string]: any;
76
- }[];
20
+ items?: Item[];
77
21
  sub_total?: {
78
22
  amount?: number;
79
23
  };
@@ -84,6 +28,17 @@ export interface ShoppingCart {
84
28
  amount?: number;
85
29
  app?: string;
86
30
  };
31
+ //@deprecated
32
+ loyalty?: {
33
+ coupon?: {
34
+ code?: string;
35
+ amount_off?: number;
36
+ amount?: number;
37
+ name?: string;
38
+ };
39
+ // Points to be earned for this shopping cart total
40
+ order_loyalty_points?: boolean;
41
+ };
87
42
  discount?: {
88
43
  code?: string;
89
44
  amount_off?: number;
@@ -119,19 +74,9 @@ export interface ShoppingCart {
119
74
  id?: string;
120
75
  tender?: string;
121
76
  };
77
+ badge_pay?: BadgePay;
122
78
  };
123
- taxes?: {
124
- amount?: number;
125
- rate?: number;
126
- breakdown?: {
127
- taxable_amount?: number;
128
- tax_collectable?: number;
129
- combined_tax_rate?: number;
130
- gst?: number;
131
- pst?: number;
132
- [index: string]: any;
133
- };
134
- };
79
+ taxes?: taxes;
135
80
  total?: {
136
81
  amount?: number;
137
82
  meals?: number;
@@ -154,8 +99,10 @@ export interface ShoppingCart {
154
99
  type?: string;
155
100
  // If an order should be paid with meal exchange. If true, this will calculate meals total.
156
101
  mx_cart?: boolean;
157
- // If a user's email domain is a match in a sites list of tax exempt domains
158
- domain_tax_exempt?: boolean;
102
+ // If a user's email or email domain is a match in a sites list of tax exempt emails or domains
103
+ email_tax_exempt?: boolean;
104
+ // Indicates to clients that a tax recalculation is required
105
+ tax_calculation_required?: boolean;
159
106
  };
160
107
  meta?: {
161
108
  // Raw request from any vendor integrated with CDL
@@ -164,9 +111,83 @@ export interface ShoppingCart {
164
111
  };
165
112
  }
166
113
 
167
- export type Item = any;
114
+ export interface Item {
115
+ // item
116
+ id: string;
117
+ // index
118
+ _index?: string;
119
+ quantity: number;
120
+ unit?: number;
121
+ price?: {
122
+ amount?: number;
123
+ };
124
+ // Final item price after LTO/Bundle/BOGO etc is applied on the item.
125
+ sale_price?: {
126
+ active?: boolean;
127
+ amount?: number;
128
+ };
129
+ // Subtotal of the item including all options
130
+ _subtotal?: {
131
+ amount?: number;
132
+ };
133
+ // Promo applied to this item
134
+ _promo?: {
135
+ amount?: number;
136
+ };
137
+ meta?: {
138
+ // menu id
139
+ menu?: string;
140
+ // brand id
141
+ brand?: string;
142
+ [index: string]: any;
143
+ };
144
+ options?: {
145
+ id?: string;
146
+ label?: {
147
+ en?: string;
148
+ };
149
+ meta?: any;
150
+ items?: {
151
+ // option
152
+ id?: string;
153
+ label?: {
154
+ en?: string;
155
+ };
156
+ // index
157
+ _index?: string;
158
+ meta?: any;
159
+ quantity?: number;
160
+ amount_off_exclusions?: string[];
161
+ }[];
162
+ }[];
163
+ // Details about discount like BOGO, LTO, Bundle etc.
164
+ item_discount?: any;
165
+ // user specified instructions for the item
166
+ special_instructions?: string;
167
+ amount_off_exclusions?: string[];
168
+ added_on?: string;
169
+ [index: string]: any;
170
+ }
171
+
172
+ export interface BadgePay {
173
+ id?: string;
174
+ total?: number;
175
+ tender?: string;
176
+ name?: string;
177
+ }
168
178
 
169
- export type taxes = ShoppingCart["taxes"];
179
+ export interface taxes {
180
+ amount?: number;
181
+ rate?: number;
182
+ breakdown?: {
183
+ taxable_amount?: number;
184
+ tax_collectable?: number;
185
+ combined_tax_rate?: number;
186
+ gst?: number;
187
+ pst?: number;
188
+ [index: string]: any;
189
+ };
190
+ }
170
191
 
171
192
  export interface LocationGroup {
172
193
  // group
@@ -178,245 +199,264 @@ export interface LocationGroup {
178
199
  };
179
200
  // Distance in meters from the group
180
201
  distance?: number;
181
- locations?: {
182
- // location
183
- id?: string;
184
- operation_id?: number;
185
- name?: string;
202
+ locations?: Location[];
203
+ address?: Address;
204
+ meta?: {
205
+ [index: string]: any;
206
+ };
207
+ style?: any;
208
+ [index: string]: any;
209
+ }
210
+
211
+ export interface Location {
212
+ // location
213
+ id?: string;
214
+ operation_id?: number;
215
+ name?: string;
216
+ label?: {
217
+ en?: string;
218
+ fr?: string;
219
+ };
220
+ search?: string[];
221
+ app?: string;
222
+ address?: Address;
223
+ latitude?: number;
224
+ longitude?: number;
225
+ brands?: Brand[];
226
+ meta?: {
227
+ [index: string]: any;
228
+ };
229
+ phone?: string;
230
+ // group
231
+ location_group?: string;
232
+ // multigroup
233
+ location_multigroup?: string;
234
+ // sector
235
+ sector?: string;
236
+ date?: {
237
+ deleted?: string;
238
+ created?: string;
239
+ modified?: string;
240
+ };
241
+ market_place?: {
186
242
  label?: {
187
243
  en?: string;
188
244
  fr?: string;
189
245
  };
190
- search?: string[];
191
- app?: string;
192
- address?: Brand["address"];
193
- latitude?: number;
194
- longitude?: number;
195
- brands?: {
196
- // brand
197
- id?: string;
198
- // sector
199
- sector?: string;
200
- name?: string;
201
- label?: {
202
- en?: string;
203
- fr?: string;
204
- };
205
- timezone?: string;
206
- description?: string;
207
- latitude?: number;
208
- longitude?: number;
209
- address?: {
210
- // Suite number of the address, if applicable
211
- suite?: string;
212
- // First line of the address, should include street number
213
- address?: string;
214
- // City of the address
215
- city?: string;
216
- // State of the address, also province in Canada
217
- state?: string;
218
- // Country of the address
219
- country?: string;
220
- // Zip code or postal code of the address
221
- zip?: string;
222
- coordinates?: {
223
- // latitude of the the address
224
- latitude?: number;
225
- // longitude of the the address
226
- longitude?: number;
227
- };
228
- };
229
- menus?: {
230
- // menu
231
- id?: string;
232
- label?: {
233
- en?: string;
234
- };
235
- hours?: any[];
236
- is_pickup?: boolean;
237
- is_delivery?: boolean;
238
- is_frictionless?: boolean;
239
- }[];
240
- date?: {
241
- created?: string;
242
- };
243
- hours?: {
244
- // hours
245
- id?: string;
246
- date?: {
247
- start?: string;
248
- end?: string;
249
- };
250
- day?: {
251
- start?: number;
252
- end?: number;
253
- };
254
- hours?: string;
255
- }[];
256
- deliveryHours?: {
257
- // hours
258
- id?: string;
259
- day?: {
260
- start?: number;
261
- end?: number;
262
- };
263
- hours?: string;
264
- }[];
265
- style?: any;
266
- // pos
267
- pos?: string;
268
- terminals?: any[];
269
- timeslots?: {
270
- time?: string;
271
- averagePrepTime?: string;
272
- duration_minutes?: number;
273
- customers_per_slot?: number;
274
- menu_items_per_slot?: number;
275
- delivery_time?: string;
276
- delivery_customers_per_slot?: number;
277
- delivery_menu_items_per_slot?: number;
278
- delivery_prep_time?: string;
279
- delivery_is_user_defined?: boolean;
280
- delivery_user_defined?: {
281
- start_time: string;
282
- end_time: string;
283
- delivery_destinations?: string[];
284
- }[];
285
- };
286
- is?: {
287
- pickup_supported?: boolean;
288
- delivery_supported?: boolean;
289
- plu_enabled?: boolean;
290
- promo_exemptions_enabled?: boolean;
291
- local_images_enabled?: boolean;
292
- hidden?: boolean;
293
- item_desc_edit_enabled?: boolean;
294
- scan_and_go_supported?: boolean;
295
- calories_edit_enabled?: boolean;
296
- // admin panel toggle
297
- special_instructions?: boolean;
298
- [index: string]: any;
299
- };
300
- // brand
301
- brand?: string;
302
- // location
303
- location?: string;
304
- // location group
305
- group?: string;
306
- // payment
307
- payment_provider?: string;
308
- location_description?: string;
309
- // company
310
- company?: string;
311
- config?: {
312
- private?: any;
313
- public?: any;
314
- };
315
- tax_rate?: number;
316
- meta?: {
317
- scout?: {
318
- user_id?: string;
319
- name?: {
320
- first?: string;
321
- last?: string;
322
- };
323
- };
324
- partner?: {
325
- user_id?: string;
326
- name?: {
327
- first?: string;
328
- last?: string;
329
- };
330
- };
331
- contact?: {
332
- name?: string;
333
- role?: string;
334
- email?: string;
335
- phone?: string;
336
- };
337
- market_id?: string;
338
- partner_type?: string;
339
- business_number?: number;
340
- website?: string;
341
- cuisine_types?: string[];
342
- status?: string;
343
- active?: boolean;
344
- max_showcase_items?: number;
345
- jde_category?: string;
346
- };
347
- descriptions?: {
348
- location?: {
349
- en?: string;
350
- fr?: string;
351
- };
352
- };
353
- [index: string]: any;
354
- }[];
355
- meta?: any;
356
- phone?: string;
357
- // group
358
- location_group?: string;
359
- // multigroup
360
- location_multigroup?: string;
361
- // sector
362
- sector?: string;
363
- date?: {
364
- created?: string;
365
- modified?: string;
246
+ location_description?: {
247
+ en?: string;
248
+ fr?: string;
366
249
  };
367
- market_place?: {
368
- label?: {
369
- en?: string;
370
- fr?: string;
371
- };
372
- location_description?: {
373
- en?: string;
374
- fr?: string;
375
- };
376
- logo?: string;
377
- is?: {
378
- pickup_supported?: boolean;
379
- delivery_supported?: boolean;
380
- };
381
- delivery_details?: {
382
- show_single_timeslot?: boolean;
383
- show_instructions?: boolean;
384
- runner_app_enabled?: boolean;
385
- };
250
+ logo?: string;
251
+ is?: {
252
+ pickup_supported?: boolean;
253
+ delivery_supported?: boolean;
254
+ };
255
+ delivery_details?: {
256
+ show_single_timeslot?: boolean;
257
+ show_instructions?: boolean;
258
+ runner_app_enabled?: boolean;
259
+ };
260
+ delivery_destinations?: string[];
261
+ pickup_instruction?: {
262
+ en?: string;
263
+ fr?: string;
264
+ };
265
+ hours?: any;
266
+ deliveryHours?: any;
267
+ service_fee?: {
268
+ type?: string;
269
+ value?: number;
270
+ };
271
+ [index: string]: any;
272
+ };
273
+ [index: string]: any;
274
+ }
275
+
276
+ export interface Brand {
277
+ // brand
278
+ id?: string;
279
+ // sector
280
+ sector?: string;
281
+ name?: string;
282
+ label?: {
283
+ en?: string;
284
+ fr?: string;
285
+ };
286
+ timezone?: string;
287
+ description?: string;
288
+ latitude?: number;
289
+ longitude?: number;
290
+ address?: Address;
291
+ menus?: MenuHours[];
292
+ date?: {
293
+ deleted?: string;
294
+ created?: string;
295
+ };
296
+ hours?: Hours[];
297
+ deliveryHours?: DeliveryHours[];
298
+ style?: any;
299
+ // pos
300
+ pos?: string;
301
+ terminals?: any[];
302
+ timeslots?: {
303
+ time?: string;
304
+ averagePrepTime?: string;
305
+ duration_minutes?: number;
306
+ customers_per_slot?: number;
307
+ menu_items_per_slot?: number;
308
+ delivery_time?: string;
309
+ delivery_customers_per_slot?: number;
310
+ delivery_menu_items_per_slot?: number;
311
+ delivery_prep_time?: string;
312
+ delivery_is_user_defined?: boolean;
313
+ delivery_user_defined?: {
314
+ start_time: string;
315
+ end_time: string;
386
316
  delivery_destinations?: string[];
387
- pickup_instruction?: {
388
- en?: string;
389
- fr?: string;
317
+ }[];
318
+ };
319
+ is?: {
320
+ pickup_supported?: boolean;
321
+ delivery_supported?: boolean;
322
+ plu_enabled?: boolean;
323
+ promo_exemptions_enabled?: boolean;
324
+ local_images_enabled?: boolean;
325
+ hidden?: boolean;
326
+ item_desc_edit_enabled?: boolean;
327
+ scan_and_go_supported?: boolean;
328
+ calories_edit_enabled?: boolean;
329
+ // admin panel toggle
330
+ special_instructions?: boolean;
331
+ [index: string]: any;
332
+ };
333
+ // brand
334
+ brand?: string;
335
+ // location
336
+ location?: string;
337
+ // location group
338
+ group?: string;
339
+ // payment
340
+ payment_provider?: string;
341
+ location_description?: string;
342
+ // company
343
+ company?: string;
344
+ config?: {
345
+ private?: any;
346
+ public?: any;
347
+ };
348
+ tax_rate?: number;
349
+ meta?: {
350
+ scout?: {
351
+ user_id?: string;
352
+ name?: {
353
+ first?: string;
354
+ last?: string;
390
355
  };
391
- hours?: any;
392
- deliveryHours?: any;
393
- service_fee?: {
394
- type?: string;
395
- value?: number;
356
+ };
357
+ partner?: {
358
+ user_id?: string;
359
+ name?: {
360
+ first?: string;
361
+ last?: string;
396
362
  };
397
- [index: string]: any;
398
363
  };
399
- [index: string]: any;
400
- }[];
401
- address?: Brand["address"];
402
- meta?: {
364
+ contact?: {
365
+ name?: string;
366
+ role?: string;
367
+ email?: string;
368
+ phone?: string;
369
+ };
370
+ market_id?: string;
371
+ partner_type?: string;
372
+ business_number?: number;
373
+ website?: string;
374
+ cuisine_types?: string[];
375
+ status?: string;
376
+ active?: boolean;
377
+ max_showcase_items?: number;
378
+ jde_category?: string;
403
379
  [index: string]: any;
404
380
  };
405
- style?: any;
381
+ descriptions?: {
382
+ location?: {
383
+ en?: string;
384
+ fr?: string;
385
+ };
386
+ };
387
+ estimated_wait_time?: {
388
+ delivery?: WaitTime;
389
+ pickup?: WaitTime;
390
+ };
406
391
  [index: string]: any;
407
392
  }
408
393
 
409
- export type Location = any;
410
-
411
- export type Brand = any;
394
+ export interface Address {
395
+ // Suite number of the address, if applicable
396
+ suite?: string;
397
+ // First line of the address, should include street number
398
+ address?: string;
399
+ // City of the address
400
+ city?: string;
401
+ // State of the address, also province in Canada
402
+ state?: string;
403
+ // Country of the address
404
+ country?: string;
405
+ // Zip code or postal code of the address
406
+ zip?: string;
407
+ coordinates?: {
408
+ // latitude of the the address
409
+ latitude?: number;
410
+ // longitude of the the address
411
+ longitude?: number;
412
+ };
413
+ }
412
414
 
413
- export type Address = Brand["address"];
415
+ export interface MenuHours {
416
+ // menu
417
+ id?: string;
418
+ label?: {
419
+ en?: string;
420
+ };
421
+ hours?: Hours[];
422
+ is_pickup?: boolean;
423
+ is_delivery?: boolean;
424
+ is_frictionless?: boolean;
425
+ }
414
426
 
415
- export type MenuHours = any;
427
+ export interface Hours {
428
+ // hours
429
+ id?: string;
430
+ date?: {
431
+ deleted?: string;
432
+ start?: string;
433
+ end?: string;
434
+ };
435
+ day?: {
436
+ start?: number;
437
+ end?: number;
438
+ };
439
+ hours?: string;
440
+ }
416
441
 
417
- export type Hours = any;
442
+ export interface DeliveryHours {
443
+ // hours
444
+ id?: string;
445
+ day?: {
446
+ start?: number;
447
+ end?: number;
448
+ };
449
+ hours?: string;
450
+ }
418
451
 
419
- export type DeliveryHours = any;
452
+ export interface WaitTime {
453
+ // maxium wait time to the next time slot in minutes
454
+ max: number;
455
+ // minimum wait time to the next time slot in minutes
456
+ min: number;
457
+ // the epoch timestamp of the next available ready time for a station
458
+ ready_time: number;
459
+ }
420
460
 
421
461
  export interface Menu {
422
462
  // menu
@@ -429,132 +469,141 @@ export interface Menu {
429
469
  label?: {
430
470
  en?: string;
431
471
  };
432
- groups?: {
433
- // group
472
+ groups?: Group[];
473
+ // menu
474
+ parent_id?: string;
475
+ // brand
476
+ location_brand?: string;
477
+ // company
478
+ company?: string;
479
+ // sector
480
+ sector?: string;
481
+ is?: {
482
+ disabled?: boolean;
483
+ hidden?: boolean;
484
+ linked?: boolean;
485
+ promo_exemptions_enabled?: boolean;
486
+ plu_enabled?: boolean;
487
+ item_images_enabled?: boolean;
488
+ item_showcase_enabled?: boolean;
489
+ item_desc_edit_enabled?: boolean;
490
+ calories_edit_enabled?: boolean;
491
+ item_label_edit_enabled?: boolean;
492
+ };
493
+ meta?: {
494
+ // User ID
495
+ locked_by_user?: string;
496
+ // User ID
497
+ last_modified_user?: string;
498
+ [index: string]: any;
499
+ };
500
+ }
501
+
502
+ export interface Group {
503
+ // group
504
+ id?: string;
505
+ label?: {
506
+ en?: string;
507
+ fr?: string;
508
+ };
509
+ items?: {
510
+ // item
434
511
  id?: string;
435
512
  label?: {
436
513
  en?: string;
437
- fr?: string;
438
514
  };
439
- items?: {
440
- // item
515
+ description?: {
516
+ en?: string;
517
+ };
518
+ price?: {
519
+ amount?: number;
520
+ currency?: string;
521
+ };
522
+ // Meal exchange value of the item
523
+ meal_value?: number;
524
+ sale_price?: {
525
+ amount?: number;
526
+ currency?: string;
527
+ };
528
+ // The number of units that belong to this item. For example, a dozen doughnuts should have a unit value of 12
529
+ unit?: number;
530
+ ingredients?: any[];
531
+ amount_off_exclusions?: string[];
532
+ nutrition?: {
533
+ kcal?: number;
534
+ calories?: any;
535
+ serving_size?: any;
536
+ total_fat?: any;
537
+ saturated_fat?: any;
538
+ trans_fat?: any;
539
+ cholesterol?: any;
540
+ sodium?: {
541
+ amount?: number;
542
+ unit?: string;
543
+ };
544
+ total_carbohydrate?: any;
545
+ dietary_fiber?: any;
546
+ sugars?: any;
547
+ protein?: any;
548
+ well_being?: any;
549
+ [index: string]: any;
550
+ };
551
+ certified?: {
552
+ vegan?: boolean;
553
+ vegetarian?: boolean;
554
+ seafood_watch?: boolean;
555
+ wellbeing?: boolean;
556
+ farm_to_fork?: boolean;
557
+ in_balance?: boolean;
558
+ organic?: boolean;
559
+ no_gluten_ingredients?: boolean;
560
+ halal?: boolean;
561
+ kosher?: boolean;
562
+ humane?: boolean;
563
+ locally_crafted?: boolean;
564
+ nuts?: boolean;
565
+ oracle_garden_grown?: boolean;
566
+ oracle_oyes?: boolean;
567
+ peanut_free?: boolean;
568
+ tree_nut_free?: boolean;
569
+ wheat_free?: boolean;
570
+ non_gmo?: boolean;
571
+ milk_free?: boolean;
572
+ egg_free?: boolean;
573
+ soy_free?: boolean;
574
+ fair_trade?: boolean;
575
+ rainforest_alliance?: boolean;
576
+ salt_free?: boolean;
577
+ };
578
+ options?: {
579
+ // modifier_group
441
580
  id?: string;
442
581
  label?: {
443
582
  en?: string;
444
583
  };
445
- description?: {
446
- en?: string;
447
- };
448
- price?: {
449
- amount?: number;
450
- currency?: string;
451
- };
452
- // Meal exchange value of the item
453
- meal_value?: number;
454
- sale_price?: {
455
- amount?: number;
456
- currency?: string;
457
- };
458
- // The number of units that belong to this item. For example, a dozen doughnuts should have a unit value of 12
459
- unit?: number;
460
- ingredients?: any[];
461
- amount_off_exclusions?: string[];
462
- nutrition?: {
463
- kcal?: number;
464
- calories?: any;
465
- serving_size?: any;
466
- total_fat?: any;
467
- saturated_fat?: any;
468
- trans_fat?: any;
469
- cholesterol?: any;
470
- sodium?: {
471
- amount?: number;
472
- unit?: string;
473
- };
474
- total_carbohydrate?: any;
475
- dietary_fiber?: any;
476
- sugars?: any;
477
- protein?: any;
478
- well_being?: any;
479
- [index: string]: any;
480
- };
481
- certified?: {
482
- vegan?: boolean;
483
- vegetarian?: boolean;
484
- seafood_watch?: boolean;
485
- wellbeing?: boolean;
486
- farm_to_fork?: boolean;
487
- in_balance?: boolean;
488
- organic?: boolean;
489
- no_gluten_ingredients?: boolean;
490
- halal?: boolean;
491
- kosher?: boolean;
492
- humane?: boolean;
493
- locally_crafted?: boolean;
494
- nuts?: boolean;
495
- oracle_garden_grown?: boolean;
496
- oracle_oyes?: boolean;
497
- peanut_free?: boolean;
498
- tree_nut_free?: boolean;
499
- wheat_free?: boolean;
500
- non_gmo?: boolean;
501
- milk_free?: boolean;
502
- egg_free?: boolean;
503
- soy_free?: boolean;
504
- fair_trade?: boolean;
505
- rainforest_alliance?: boolean;
506
- salt_free?: boolean;
507
- };
508
- options?: {
509
- // modifier_group
584
+ unique_name?: string;
585
+ items?: {
586
+ // option
510
587
  id?: string;
511
588
  label?: {
512
589
  en?: string;
513
590
  };
514
- unique_name?: string;
515
- items?: {
516
- // option
517
- id?: string;
518
- label?: {
519
- en?: string;
520
- };
521
- price?: {
522
- amount?: number;
523
- currency?: string;
524
- };
525
- sku?: number;
526
- nutrition?: {
527
- kcal?: number;
528
- calories?: any;
529
- };
530
- certified?: {
531
- vegan?: boolean;
532
- };
533
- modifier_sets?: {
534
- category?: string;
535
- list?: string[];
536
- }[];
537
- meta?: {
538
- // chit sort order
539
- sort_number?: number;
540
- // menu sort order
541
- menu_sort_number?: number;
542
- [index: string]: any;
543
- };
544
- is?: {
545
- disabled?: boolean;
546
- hidden?: boolean;
547
- out_of_stock?: boolean;
548
- };
549
- amount_off_exclusions?: any[];
550
- }[];
551
- min?: number;
552
- max?: number;
553
- is?: {
554
- disabled?: boolean;
555
- hidden?: boolean;
556
- out_of_stock?: boolean;
591
+ price?: {
592
+ amount?: number;
593
+ currency?: string;
557
594
  };
595
+ sku?: number;
596
+ nutrition?: {
597
+ kcal?: number;
598
+ calories?: any;
599
+ };
600
+ certified?: {
601
+ vegan?: boolean;
602
+ };
603
+ modifier_sets?: {
604
+ category?: string;
605
+ list?: string[];
606
+ }[];
558
607
  meta?: {
559
608
  // chit sort order
560
609
  sort_number?: number;
@@ -562,91 +611,82 @@ export interface Menu {
562
611
  menu_sort_number?: number;
563
612
  [index: string]: any;
564
613
  };
565
- [index: string]: any;
614
+ is?: {
615
+ disabled?: boolean;
616
+ hidden?: boolean;
617
+ out_of_stock?: boolean;
618
+ };
619
+ amount_off_exclusions?: any[];
566
620
  }[];
567
- required?: boolean;
568
- special?: boolean;
621
+ min?: number;
622
+ max?: number;
623
+ is?: {
624
+ disabled?: boolean;
625
+ hidden?: boolean;
626
+ out_of_stock?: boolean;
627
+ };
569
628
  meta?: {
570
- superplate?: {
571
- type_id?: number;
572
- type?: string;
573
- };
574
- featured?: {
575
- sort_number?: number;
576
- dates?: {
577
- start?: string;
578
- end?: string;
579
- };
580
- };
581
629
  // chit sort order
582
630
  sort_number?: number;
583
631
  // menu sort order
584
632
  menu_sort_number?: number;
633
+ [index: string]: any;
585
634
  };
586
- category?: {
587
- en?: string;
588
- };
589
- location?: string;
590
- sku?: number;
591
- item_number?: number;
592
- image?: {
593
- src?: string;
594
- };
595
- is_deleted?: boolean;
596
- is?: {
597
- disabled?: boolean;
598
- hidden?: boolean;
599
- meq_eligible?: boolean;
600
- out_of_stock?: boolean;
601
- deleted?: boolean;
602
- featured?: boolean;
603
- };
635
+ [index: string]: any;
604
636
  }[];
605
- is_disabled?: boolean;
606
- name?: string;
607
- is?: {
608
- disabled?: boolean;
609
- hidden?: boolean;
610
- };
637
+ required?: boolean;
638
+ special?: boolean;
611
639
  meta?: {
640
+ superplate?: {
641
+ type_id?: number;
642
+ type?: string;
643
+ };
644
+ featured?: {
645
+ sort_number?: number;
646
+ dates?: {
647
+ start?: string;
648
+ end?: string;
649
+ };
650
+ };
612
651
  // chit sort order
613
652
  sort_number?: number;
614
653
  // menu sort order
615
654
  menu_sort_number?: number;
616
- [index: string]: any;
655
+ };
656
+ category?: {
657
+ en?: string;
658
+ };
659
+ location?: string;
660
+ sku?: number;
661
+ item_number?: number;
662
+ image?: {
663
+ src?: string;
664
+ };
665
+ is_deleted?: boolean;
666
+ is?: {
667
+ disabled?: boolean;
668
+ hidden?: boolean;
669
+ meq_eligible?: boolean;
670
+ out_of_stock?: boolean;
671
+ deleted?: boolean;
672
+ featured?: boolean;
617
673
  };
618
674
  }[];
619
- // menu
620
- parent_id?: string;
621
- // brand
622
- location_brand?: string;
623
- // company
624
- company?: string;
625
- // sector
626
- sector?: string;
675
+ is_disabled?: boolean;
676
+ name?: string;
627
677
  is?: {
628
678
  disabled?: boolean;
629
679
  hidden?: boolean;
630
- linked?: boolean;
631
- promo_exemptions_enabled?: boolean;
632
- plu_enabled?: boolean;
633
- item_images_enabled?: boolean;
634
- item_showcase_enabled?: boolean;
635
- item_desc_edit_enabled?: boolean;
636
- calories_edit_enabled?: boolean;
637
- item_label_edit_enabled?: boolean;
638
680
  };
639
681
  meta?: {
640
- // User ID
641
- locked_by_user?: string;
642
- // User ID
643
- last_modified_user?: string;
682
+ // chit sort order
683
+ sort_number?: number;
684
+ // menu sort order
685
+ menu_sort_number?: number;
644
686
  [index: string]: any;
645
687
  };
646
688
  }
647
689
 
648
- export type Group = any;
649
-
650
690
  export interface CognitionStore {
651
691
  // UUID for external store
652
692
  uuid?: string;
@@ -709,7 +749,7 @@ export interface GetPartnerStandardcognitionLocationsQuery {
709
749
  }
710
750
 
711
751
  export interface GetPartnerStandardcognitionLocationsResponse {
712
- groups?: LocationGroup;
752
+ groups?: LocationGroup[];
713
753
  }
714
754
 
715
755
  export interface GetPartnerStandardcognitionLocationsRequest