@compassdigital/sdk.typescript 4.621.0 → 4.622.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.
@@ -1978,23 +1978,90 @@ export interface GetMenuItemNutritionConsumer {
1978
1978
  calories?: GetMenuItemNutritionValueConsumer;
1979
1979
  }
1980
1980
 
1981
+ export interface Certified {
1982
+ // Certified vegan
1983
+ vegan?: boolean;
1984
+ // Certified vegetarian
1985
+ vegetarian?: boolean;
1986
+ // Seafood Watch certified (sustainable seafood)
1987
+ seafood_watch?: boolean;
1988
+ // Certified for general wellbeing
1989
+ wellbeing?: boolean;
1990
+ // Farm to Fork certified (locally sourced)
1991
+ farm_to_fork?: boolean;
1992
+ // In Balance certified (nutritionally balanced)
1993
+ in_balance?: boolean;
1994
+ // Certified organic
1995
+ organic?: boolean;
1996
+ // No gluten ingredients present
1997
+ no_gluten_ingredients?: boolean;
1998
+ // Certified halal
1999
+ halal?: boolean;
2000
+ // Certified kosher
2001
+ kosher?: boolean;
2002
+ // Certified humane (animal welfare)
2003
+ humane?: boolean;
2004
+ // Locally crafted product
2005
+ locally_crafted?: boolean;
2006
+ // Contains nuts
2007
+ nuts?: boolean;
2008
+ // Oracle Garden Grown certified
2009
+ oracle_garden_grown?: boolean;
2010
+ // Oracle OYES certified
2011
+ oracle_oyes?: boolean;
2012
+ // Peanut free
2013
+ peanut_free?: boolean;
2014
+ // Tree nut free
2015
+ tree_nut_free?: boolean;
2016
+ // Wheat free
2017
+ wheat_free?: boolean;
2018
+ // Non-GMO certified
2019
+ non_gmo?: boolean;
2020
+ // Milk free
2021
+ milk_free?: boolean;
2022
+ // Egg free
2023
+ egg_free?: boolean;
2024
+ // Soy free
2025
+ soy_free?: boolean;
2026
+ // Fair Trade certified
2027
+ fair_trade?: boolean;
2028
+ // Rainforest Alliance certified
2029
+ rainforest_alliance?: boolean;
2030
+ // Salt free
2031
+ salt_free?: boolean;
2032
+ }
2033
+
1981
2034
  export interface GetMenuOptionNutritionConsumer {
2035
+ // Calories
1982
2036
  calories?: GetMenuItemNutritionValueConsumer;
2037
+ // Total fat
1983
2038
  total_fat?: GetMenuItemNutritionValueConsumer;
2039
+ // Saturated fat
1984
2040
  saturated_fat?: GetMenuItemNutritionValueConsumer;
2041
+ // Total carbohydrates
1985
2042
  total_carbohydrate?: GetMenuItemNutritionValueConsumer;
2043
+ // Total sugars
1986
2044
  total_sugars?: GetMenuItemNutritionValueConsumer;
2045
+ // Protein
1987
2046
  protein?: GetMenuItemNutritionValueConsumer;
2047
+ // Dietary fiber
1988
2048
  dietary_fiber?: GetMenuItemNutritionValueConsumer;
2049
+ // Sodium
1989
2050
  sodium?: GetMenuItemNutritionValueConsumer;
2051
+ // Trans fat
1990
2052
  trans_fat?: GetMenuItemNutritionValueConsumer;
2053
+ // Cholesterol
1991
2054
  cholesterol?: GetMenuItemNutritionValueConsumer;
2055
+ // Added sugars
1992
2056
  added_sugars?: GetMenuItemNutritionValueConsumer;
1993
2057
  }
1994
2058
 
1995
2059
  export interface GetMenuItemOptionSizingConsumer {
2060
+ // Sizing name
1996
2061
  name?: string;
2062
+ // POS ID for sizing
1997
2063
  posid?: string;
2064
+ // Price for this sizing
1998
2065
  price?: number;
1999
2066
  }
2000
2067
 
@@ -2003,16 +2070,6 @@ export interface GetMenuItemOptionMetaConsumer {
2003
2070
  sizing?: GetMenuItemOptionSizingConsumer[];
2004
2071
  }
2005
2072
 
2006
- export interface GetMenuItemImageSizesConsumer {
2007
- original?: string;
2008
- thumbnail_80_80?: string;
2009
- }
2010
-
2011
- export interface GetMenuItemImageConsumer {
2012
- src?: string;
2013
- sizes?: GetMenuItemImageSizesConsumer;
2014
- }
2015
-
2016
2073
  export interface GetMenuItemOptionConsumer {
2017
2074
  // Menu Option ID
2018
2075
  id?: string;
@@ -2027,6 +2084,7 @@ export interface GetMenuItemOptionConsumer {
2027
2084
  }
2028
2085
 
2029
2086
  export interface GetMenuItemGroupIsConsumer {
2087
+ // Options group incremental?
2030
2088
  incremental?: boolean;
2031
2089
  }
2032
2090
 
@@ -2038,11 +2096,17 @@ export interface GetMenuItemGroupMetaConsumer {
2038
2096
  export interface GetMenuItemOptionsGroupConsumer {
2039
2097
  // Menu Options Group ID
2040
2098
  id?: string;
2099
+ // Label for the options group
2041
2100
  label?: GetMenuItemLabelConsumer;
2101
+ // Options group items
2042
2102
  items?: GetMenuItemOptionConsumer[];
2103
+ // Minimum number of options
2043
2104
  min?: number;
2105
+ // Maximum number of options
2044
2106
  max?: number;
2107
+ // Object containing quick boolean details
2045
2108
  is?: GetMenuItemGroupIsConsumer;
2109
+ // Metadata for the options group
2046
2110
  meta?: GetMenuItemGroupMetaConsumer;
2047
2111
  }
2048
2112
 
@@ -2060,14 +2124,31 @@ export interface GetMenuItemMetaConsumer {
2060
2124
  recipe?: GetMenuItemRecipeConsumer;
2061
2125
  }
2062
2126
 
2127
+ export interface GetMenuItemImageSizesConsumer {
2128
+ // Image URL
2129
+ original?: string;
2130
+ // 80x80 thumbnail image URL
2131
+ thumbnail_80_80?: string;
2132
+ }
2133
+
2134
+ export interface GetMenuItemImageConsumer {
2135
+ // Image source URL
2136
+ src?: string;
2137
+ // Image sizes
2138
+ sizes?: GetMenuItemImageSizesConsumer;
2139
+ }
2140
+
2063
2141
  export interface GetMenuItemIsConsumer {
2064
2142
  // Is the item out of stock?
2065
2143
  out_of_stock?: boolean;
2066
2144
  }
2067
2145
 
2068
2146
  export interface GetMenuItemMenuLabelConsumer {
2147
+ // Menu label ID
2069
2148
  id?: string;
2149
+ // Menu label text
2070
2150
  text?: string;
2151
+ // Image for Menu label S3 link
2071
2152
  s3_link?: string;
2072
2153
  }
2073
2154
 
@@ -2115,11 +2196,501 @@ export interface GetMenuResponseConsumer {
2115
2196
  // menu id
2116
2197
  id: string;
2117
2198
  // menu label
2118
- label?: GetMenuLabelConsumer;
2199
+ label?: GetMenuLabelConsumer;
2200
+ // menu groups
2201
+ groups?: GetMenuGroupConsumer[];
2202
+ // menu parent id
2203
+ parent_id?: string;
2204
+ }
2205
+
2206
+ export interface GetMenuLabelConsumerV2 {
2207
+ // English
2208
+ en?: string;
2209
+ }
2210
+
2211
+ export interface GetMenuGroupLabelConsumerV2 {
2212
+ // English
2213
+ en?: string;
2214
+ // French
2215
+ fr?: string;
2216
+ }
2217
+
2218
+ export interface GetMenuItemLabelConsumerV2 {
2219
+ // English
2220
+ en?: string;
2221
+ }
2222
+
2223
+ export interface GetMenuItemPriceConsumerV2 {
2224
+ // Amount
2225
+ amount?: number;
2226
+ // Currency code
2227
+ currency?: string;
2228
+ // Total price
2229
+ total_price?: number;
2230
+ // Discount amount
2231
+ discount?: number;
2232
+ }
2233
+
2234
+ export interface GetMenuItemNutritionValueConsumerV2 {
2235
+ // Amount
2236
+ amount?: number;
2237
+ // Unit of measurement
2238
+ unit?: string;
2239
+ // Display string for calories (e.g., "620 kcal")
2240
+ display?: string;
2241
+ }
2242
+
2243
+ export interface GetMenuItemNutritionConsumerV2 {
2244
+ // Deprecated calorie value in kcal
2245
+ kcal?: number;
2246
+ // Calories
2247
+ calories?: GetMenuItemNutritionValueConsumerV2;
2248
+ // Serving size
2249
+ serving_size?: GetMenuItemNutritionValueConsumerV2;
2250
+ // Total fat
2251
+ total_fat?: GetMenuItemNutritionValueConsumerV2;
2252
+ // Saturated fat
2253
+ saturated_fat?: GetMenuItemNutritionValueConsumerV2;
2254
+ // Trans fat
2255
+ trans_fat?: GetMenuItemNutritionValueConsumerV2;
2256
+ // Cholesterol
2257
+ cholesterol?: GetMenuItemNutritionValueConsumerV2;
2258
+ // Sodium
2259
+ sodium?: GetMenuItemNutritionValueConsumerV2;
2260
+ // Total carbohydrates
2261
+ total_carbohydrate?: GetMenuItemNutritionValueConsumerV2;
2262
+ // Dietary fiber
2263
+ dietary_fiber?: GetMenuItemNutritionValueConsumerV2;
2264
+ // Sugars
2265
+ sugars?: GetMenuItemNutritionValueConsumerV2;
2266
+ // Total sugars
2267
+ total_sugars?: GetMenuItemNutritionValueConsumerV2;
2268
+ // Protein
2269
+ protein?: GetMenuItemNutritionValueConsumerV2;
2270
+ // Well-being score
2271
+ well_being?: GetMenuItemNutritionValueConsumerV2;
2272
+ }
2273
+
2274
+ export interface GetMenuItemCertifiedConsumerV2 {
2275
+ // Certified vegan
2276
+ vegan?: boolean;
2277
+ // Certified vegetarian
2278
+ vegetarian?: boolean;
2279
+ // Seafood Watch certified (sustainable seafood)
2280
+ seafood_watch?: boolean;
2281
+ // Certified for general wellbeing
2282
+ wellbeing?: boolean;
2283
+ // Farm to Fork certified (locally sourced)
2284
+ farm_to_fork?: boolean;
2285
+ // In Balance certified (nutritionally balanced)
2286
+ in_balance?: boolean;
2287
+ // Certified organic
2288
+ organic?: boolean;
2289
+ // No gluten ingredients present
2290
+ no_gluten_ingredients?: boolean;
2291
+ // Certified halal
2292
+ halal?: boolean;
2293
+ // Certified kosher
2294
+ kosher?: boolean;
2295
+ // Certified humane (animal welfare)
2296
+ humane?: boolean;
2297
+ // Locally crafted product
2298
+ locally_crafted?: boolean;
2299
+ // Contains nuts
2300
+ nuts?: boolean;
2301
+ // Oracle Garden Grown certified
2302
+ oracle_garden_grown?: boolean;
2303
+ // Oracle OYES certified
2304
+ oracle_oyes?: boolean;
2305
+ // Peanut free
2306
+ peanut_free?: boolean;
2307
+ // Tree nut free
2308
+ tree_nut_free?: boolean;
2309
+ // Wheat free
2310
+ wheat_free?: boolean;
2311
+ // Non-GMO certified
2312
+ non_gmo?: boolean;
2313
+ // Milk free
2314
+ milk_free?: boolean;
2315
+ // Egg free
2316
+ egg_free?: boolean;
2317
+ // Soy free
2318
+ soy_free?: boolean;
2319
+ // Fair Trade certified
2320
+ fair_trade?: boolean;
2321
+ // Rainforest Alliance certified
2322
+ rainforest_alliance?: boolean;
2323
+ // Salt free
2324
+ salt_free?: boolean;
2325
+ }
2326
+
2327
+ export interface GetMenuOptionNutritionConsumerV2 {
2328
+ // Calories
2329
+ calories?: GetMenuItemNutritionValueConsumerV2;
2330
+ // Total fat
2331
+ total_fat?: GetMenuItemNutritionValueConsumerV2;
2332
+ // Saturated fat
2333
+ saturated_fat?: GetMenuItemNutritionValueConsumerV2;
2334
+ // Total carbohydrates
2335
+ total_carbohydrate?: GetMenuItemNutritionValueConsumerV2;
2336
+ // Total sugars
2337
+ total_sugars?: GetMenuItemNutritionValueConsumerV2;
2338
+ // Protein
2339
+ protein?: GetMenuItemNutritionValueConsumerV2;
2340
+ // Dietary fiber
2341
+ dietary_fiber?: GetMenuItemNutritionValueConsumerV2;
2342
+ // Sodium
2343
+ sodium?: GetMenuItemNutritionValueConsumerV2;
2344
+ // Trans fat
2345
+ trans_fat?: GetMenuItemNutritionValueConsumerV2;
2346
+ // Cholesterol
2347
+ cholesterol?: GetMenuItemNutritionValueConsumerV2;
2348
+ // Added sugars
2349
+ added_sugars?: GetMenuItemNutritionValueConsumerV2;
2350
+ }
2351
+
2352
+ export interface GetMenuItemOptionSizingConsumerV2 {
2353
+ // Sizing name
2354
+ name?: string;
2355
+ // POS ID for sizing
2356
+ posid?: string;
2357
+ // Price for this sizing
2358
+ price?: number;
2359
+ }
2360
+
2361
+ export interface GetMenuItemOptionMetaConsumerV2 {
2362
+ // Available sizings
2363
+ sizing?: GetMenuItemOptionSizingConsumerV2[];
2364
+ // Chit sort order
2365
+ sort_number?: number;
2366
+ // Menu sort order
2367
+ menu_sort_number?: number;
2368
+ // Unique ID of the entity
2369
+ unique_id?: number;
2370
+ tax?: {
2371
+ tax_tag_code?: string;
2372
+ };
2373
+ }
2374
+
2375
+ export interface GetMenuItemImageSizesConsumerV2 {
2376
+ // Image URL
2377
+ original?: string;
2378
+ // 80x80 thumbnail image URL
2379
+ thumbnail_80_80?: string;
2380
+ }
2381
+
2382
+ export interface GetMenuItemImageConsumerV2 {
2383
+ // Image source URL
2384
+ src?: string;
2385
+ // Image sizes
2386
+ sizes?: GetMenuItemImageSizesConsumerV2;
2387
+ }
2388
+
2389
+ export interface GetMenuItemOptionIsConsumerV2 {
2390
+ // Is the option disabled
2391
+ disabled?: boolean;
2392
+ // Is the option hidden
2393
+ hidden?: boolean;
2394
+ // Is the option out of stock
2395
+ out_of_stock?: boolean;
2396
+ }
2397
+
2398
+ export interface GetMenuItemReportingConsumerV2 {
2399
+ category?: {
2400
+ primary?: string;
2401
+ secondary?: string;
2402
+ };
2403
+ // JDE category
2404
+ jde_category?: string;
2405
+ }
2406
+
2407
+ export interface GetMenuItemOptionConsumerV2 {
2408
+ // Menu Option ID
2409
+ id?: string;
2410
+ // Label for the option
2411
+ label?: GetMenuItemLabelConsumerV2;
2412
+ // Name of the option
2413
+ name?: string;
2414
+ // Description of the option
2415
+ description?: GetMenuItemLabelConsumerV2;
2416
+ // Price
2417
+ price?: GetMenuItemPriceConsumerV2;
2418
+ // Nutrition information
2419
+ nutrition?: GetMenuOptionNutritionConsumerV2;
2420
+ // Metadata for the option
2421
+ meta?: GetMenuItemOptionMetaConsumerV2;
2422
+ // Item image data
2423
+ image?: GetMenuItemImageConsumerV2;
2424
+ // Food certifications
2425
+ certified?: GetMenuItemCertifiedConsumerV2;
2426
+ // Quick boolean details
2427
+ is?: GetMenuItemOptionIsConsumerV2;
2428
+ // Reporting metadata
2429
+ reporting?: GetMenuItemReportingConsumerV2;
2430
+ // SKU number
2431
+ sku?: number;
2432
+ weight?: {
2433
+ unit?: string;
2434
+ amount?: number;
2435
+ };
2436
+ // Line route
2437
+ line_route?: string;
2438
+ // Amount off exclusion types
2439
+ amount_off_exclusions?: string[];
2440
+ }
2441
+
2442
+ export interface GetMenuItemGroupIsConsumerV2 {
2443
+ // Options group incremental
2444
+ incremental?: boolean;
2445
+ }
2446
+
2447
+ export interface GetMenuItemGroupMetaConsumerV2 {
2448
+ // Type of mod group
2449
+ order_type?: 'selection' | 'option' | 'quantity';
2450
+ // Chit sort order
2451
+ sort_number?: number;
2452
+ // Menu sort order
2453
+ menu_sort_number?: number;
2454
+ // Number of modifiers before surcharge applies
2455
+ surcharge_limit_value?: number;
2456
+ }
2457
+
2458
+ export interface GetMenuItemOptionsGroupConsumerV2 {
2459
+ // Menu Options Group ID
2460
+ id?: string;
2461
+ // Label for the options group
2462
+ label?: GetMenuItemLabelConsumerV2;
2463
+ // Options group items
2464
+ items?: GetMenuItemOptionConsumerV2[];
2465
+ // Minimum number of options
2466
+ min?: number;
2467
+ // Maximum number of options
2468
+ max?: number;
2469
+ // Quick boolean details
2470
+ is?: GetMenuItemGroupIsConsumerV2;
2471
+ // Metadata for the options group
2472
+ meta?: GetMenuItemGroupMetaConsumerV2;
2473
+ }
2474
+
2475
+ export interface GetMenuItemRecipeConsumerV2 {
2476
+ // Smart tags
2477
+ smart_tags?: string[];
2478
+ // Allergen tags
2479
+ allergen_tags?: string[];
2480
+ // MenuWorks MRN
2481
+ mrn?: string;
2482
+ // MenuWorks unit ID
2483
+ unit_id?: string;
2484
+ // MenuWorks portion quantity
2485
+ portion_quantity?: number;
2486
+ // MenuWorks portion unit name
2487
+ portion_unit_name?: string;
2488
+ // MenuWorks grams
2489
+ grams?: number;
2490
+ // MenuWorks cost per serving
2491
+ cost?: number;
2492
+ // MenuWorks ingredients
2493
+ ingredients?: string[];
2494
+ }
2495
+
2496
+ export interface GetMenuItemMetaConsumerV2 {
2497
+ // Barcodes of the item
2498
+ barcodes?: string[];
2499
+ // Recipe metadata
2500
+ recipe?: GetMenuItemRecipeConsumerV2;
2501
+ superplate?: {
2502
+ type_id?: number;
2503
+ type?: string;
2504
+ };
2505
+ // Chit sort order
2506
+ sort_number?: number;
2507
+ // Menu sort order
2508
+ menu_sort_number?: number;
2509
+ // Unique ID of the entity
2510
+ unique_id?: number;
2511
+ tax?: {
2512
+ tax_tag_code?: string;
2513
+ tax_jwo_code?: string;
2514
+ tax_rate?: number;
2515
+ tax_amount?: number;
2516
+ };
2517
+ }
2518
+
2519
+ export interface GetMenuItemIsConsumerV2 {
2520
+ // Is the item disabled
2521
+ disabled?: boolean;
2522
+ // Is the item hidden
2523
+ hidden?: boolean;
2524
+ // Is the item MEQ eligible
2525
+ meq_eligible?: boolean;
2526
+ // Is the item out of stock
2527
+ out_of_stock?: boolean;
2528
+ // Is the item deleted
2529
+ deleted?: boolean;
2530
+ // Is the item featured
2531
+ featured?: boolean;
2532
+ }
2533
+
2534
+ export interface GetMenuItemMenuLabelConsumerV2 {
2535
+ // Menu label ID
2536
+ id?: string;
2537
+ // Menu label text
2538
+ text?: string;
2539
+ // Image for menu label S3 link
2540
+ s3_link?: string;
2541
+ }
2542
+
2543
+ export interface GetMenuItemConsumerV2 {
2544
+ // Menu Item ID
2545
+ id?: string;
2546
+ // Label for the menu item
2547
+ label?: GetMenuItemLabelConsumerV2;
2548
+ // Name of the item
2549
+ name?: string;
2550
+ // Description of the item
2551
+ description?: GetMenuItemLabelConsumerV2;
2552
+ // Item price
2553
+ price?: GetMenuItemPriceConsumerV2;
2554
+ // Meal exchange value of the item
2555
+ meal_value?: number;
2556
+ // Sale price of the item
2557
+ sale_price?: GetMenuItemPriceConsumerV2;
2558
+ // Number of units for the item
2559
+ unit?: number;
2560
+ // SKU number
2561
+ sku?: number;
2562
+ // Item number
2563
+ item_number?: number;
2564
+ // Parent item ID
2565
+ parent_id?: string;
2566
+ // Location ID
2567
+ location?: string;
2568
+ // Line route
2569
+ line_route?: string;
2570
+ weight?: {
2571
+ unit?: string;
2572
+ amount?: number;
2573
+ };
2574
+ category?: {
2575
+ en?: string;
2576
+ };
2577
+ // Ingredients list
2578
+ ingredients?: Record<string, any>[];
2579
+ // Amount off exclusion types
2580
+ amount_off_exclusions?: string[];
2581
+ // Item nutrition
2582
+ nutrition?: GetMenuItemNutritionConsumerV2;
2583
+ // Food certifications like vegan, organic, etc
2584
+ certified?: GetMenuItemCertifiedConsumerV2;
2585
+ // Item options/modifiers
2586
+ options?: GetMenuItemOptionsGroupConsumerV2[];
2587
+ // Metadata for the item
2588
+ meta?: GetMenuItemMetaConsumerV2;
2589
+ // Item image data
2590
+ image?: GetMenuItemImageConsumerV2;
2591
+ // Quick boolean details
2592
+ is?: GetMenuItemIsConsumerV2;
2593
+ // Menu labels
2594
+ menu_labels?: GetMenuItemMenuLabelConsumerV2[];
2595
+ // Reporting metadata
2596
+ reporting?: GetMenuItemReportingConsumerV2;
2597
+ }
2598
+
2599
+ export interface GetMenuGroupConsumerV2 {
2600
+ // Menu Group ID
2601
+ id?: string;
2602
+ // Menu Group label
2603
+ label?: GetMenuGroupLabelConsumerV2;
2604
+ // Menu Items
2605
+ items?: GetMenuItemConsumerV2[];
2606
+ }
2607
+
2608
+ export interface GetMenuDateConsumerV2 {
2609
+ // Date created
2610
+ created?: string;
2611
+ // Date last modified
2612
+ modified?: string;
2613
+ // Date published
2614
+ published?: string;
2615
+ }
2616
+
2617
+ export interface GetMenuIsConsumerV2 {
2618
+ // Is the menu disabled
2619
+ disabled?: boolean;
2620
+ // Is the menu hidden
2621
+ hidden?: boolean;
2622
+ // Is the menu linked
2623
+ linked?: boolean;
2624
+ // Are promo exemptions enabled
2625
+ promo_exemptions_enabled?: boolean;
2626
+ // Is PLU enabled
2627
+ plu_enabled?: boolean;
2628
+ // Are item images enabled
2629
+ item_images_enabled?: boolean;
2630
+ // Is item showcase enabled
2631
+ item_showcase_enabled?: boolean;
2632
+ // Is item description editing enabled
2633
+ item_desc_edit_enabled?: boolean;
2634
+ // Is calories editing enabled
2635
+ calories_edit_enabled?: boolean;
2636
+ // Is item label editing enabled
2637
+ item_label_edit_enabled?: boolean;
2638
+ // Is frictionless enabled
2639
+ frictionless?: boolean;
2640
+ // Are category images enabled
2641
+ category_images_enabled?: boolean;
2642
+ }
2643
+
2644
+ export interface GetMenuMetaConsumerV2 {
2645
+ // User who locked the menu
2646
+ locked_by_user?: string;
2647
+ // User who last modified the menu
2648
+ last_modified_user?: string;
2649
+ // Is this a Centricos menu
2650
+ centricos?: boolean;
2651
+ // Menu version number
2652
+ version?: number;
2653
+ // Menu revision identifier
2654
+ revision?: string;
2655
+ }
2656
+
2657
+ export interface GetMenuImageSizesConsumerV2 {
2658
+ // Original image URL
2659
+ original?: string;
2660
+ // 80x80 thumbnail image URL
2661
+ thumbnail_80_80?: string;
2662
+ }
2663
+
2664
+ export interface GetMenuImageConsumerV2 {
2665
+ // Image source URL
2666
+ src?: string;
2667
+ // Image sizes
2668
+ sizes?: GetMenuImageSizesConsumerV2;
2669
+ }
2670
+
2671
+ export interface GetMenuResponseConsumerV2 {
2672
+ // menu id
2673
+ id: string;
2674
+ // menu label
2675
+ label?: GetMenuLabelConsumerV2;
2119
2676
  // menu groups
2120
- groups?: GetMenuGroupConsumer[];
2677
+ groups?: GetMenuGroupConsumerV2[];
2121
2678
  // menu parent id
2122
2679
  parent_id?: string;
2680
+ // location brand id
2681
+ location_brand?: string;
2682
+ // company id
2683
+ company?: string;
2684
+ // sector id
2685
+ sector?: string;
2686
+ // Menu date metadata
2687
+ date?: GetMenuDateConsumerV2;
2688
+ // Quick boolean details
2689
+ is?: GetMenuIsConsumerV2;
2690
+ // Menu metadata
2691
+ meta?: GetMenuMetaConsumerV2;
2692
+ // Menu image
2693
+ image?: GetMenuImageConsumerV2;
2123
2694
  }
2124
2695
 
2125
2696
  export interface GetConsumerMenuItemsResponse {
@@ -3454,11 +4025,11 @@ export interface PatchConsumerShoppingCartResponse {
3454
4025
 
3455
4026
  export interface PostConsumerShoppingCartCloneBodyRequest {
3456
4027
  // menu id
3457
- menu: string;
4028
+ menu?: string;
3458
4029
  // order type
3459
- order_type: string;
4030
+ order_type?: string;
3460
4031
  // array of item indexes that should be cloned
3461
- items_to_clone: string[];
4032
+ items_to_clone?: string[];
3462
4033
  }
3463
4034
 
3464
4035
  export interface PostCustomerRewardsBodyDTO {
@@ -3793,454 +4364,97 @@ export interface ReviewDTO {
3793
4364
  createdAt: string;
3794
4365
  updatedAt: string;
3795
4366
  score?: number;
3796
- comment?: string;
3797
- reason?: [];
3798
- }
3799
-
3800
- export interface GetReviewOrderItemsRequestDTO {
3801
- reviews: ReviewDTO[];
3802
- }
3803
-
3804
- export interface PostConsumerShoppingCartBulkBodyRequest {
3805
- // ids of the shopping carts to get
3806
- ids: string[];
3807
- }
3808
-
3809
- export interface PostConsumerShoppingCartBulkResponse {
3810
- // shopping carts
3811
- shoppingcarts: PostConsumerShoppingCartResponse[];
3812
- }
3813
-
3814
- export interface ConsumerDeleteMealplanBody {
3815
- // mealplan tenders to delete
3816
- tenders?: string[];
3817
- }
3818
-
3819
- export interface PostExternalExchangeLoginCodeRequestDTO {
3820
- // One-time code from the app login link
3821
- code: string;
3822
- }
3823
-
3824
- export interface AccessTokenPartDTO {
3825
- token: string;
3826
- expires: string;
3827
- }
3828
-
3829
- export interface ProfileNameDTO {
3830
- first: string;
3831
- last: string;
3832
- }
3833
-
3834
- export interface ProfileDateDTO {
3835
- modified?: string;
3836
- created?: string;
3837
- }
3838
-
3839
- export interface ProfileIsDTO {
3840
- disabled: boolean;
3841
- verified: boolean;
3842
- }
3843
-
3844
- export interface ExchangeProfileDTO {
3845
- id: string;
3846
- email: string;
3847
- name?: ProfileNameDTO;
3848
- date?: ProfileDateDTO;
3849
- is?: ProfileIsDTO;
3850
- // Additional user metadata
3851
- meta?: Record<string, any>;
3852
- }
3853
-
3854
- export interface PostExternalExchangeLoginCodeResponseDTO {
3855
- access: AccessTokenPartDTO;
3856
- profile: ExchangeProfileDTO;
3857
- }
3858
-
3859
- export interface GetConsumerLocationResponse {
3860
- // id
3861
- id: string;
3862
- date?: {
3863
- created?: string;
3864
- modified?: string;
3865
- };
3866
- // name
3867
- name: string;
3868
- label?: {
3869
- en?: string;
3870
- fr?: string;
3871
- };
3872
- // distance in meters from the group
3873
- distance?: number;
3874
- // meta data
3875
- meta?: Record<string, any>;
3876
- style?: {
3877
- logo?: string | null;
3878
- main_logo?: string | null;
3879
- alt_logo?: string | null;
3880
- };
3881
- // timezone
3882
- timezone?: string;
3883
- // site operational status
3884
- status?: Record<string, any>;
3885
- locations?: ConsumerLocation[];
3886
- address?: ConsumerAddress;
3887
- }
3888
-
3889
- export interface GetMenuItemNutritionValueConsumerV2 {
3890
- amount?: number;
3891
- unit?: string;
3892
- display?: string;
3893
- }
3894
-
3895
- export interface GetMenuItemNutritionConsumerV2 {
3896
- kcal?: number;
3897
- calories?: GetMenuItemNutritionValueConsumerV2;
3898
- serving_size?: GetMenuItemNutritionValueConsumerV2;
3899
- total_fat?: GetMenuItemNutritionValueConsumerV2;
3900
- saturated_fat?: GetMenuItemNutritionValueConsumerV2;
3901
- trans_fat?: GetMenuItemNutritionValueConsumerV2;
3902
- cholesterol?: GetMenuItemNutritionValueConsumerV2;
3903
- sodium?: GetMenuItemNutritionValueConsumerV2;
3904
- total_carbohydrate?: GetMenuItemNutritionValueConsumerV2;
3905
- dietary_fiber?: GetMenuItemNutritionValueConsumerV2;
3906
- sugars?: GetMenuItemNutritionValueConsumerV2;
3907
- total_sugars?: GetMenuItemNutritionValueConsumerV2;
3908
- protein?: GetMenuItemNutritionValueConsumerV2;
3909
- well_being?: GetMenuItemNutritionValueConsumerV2;
3910
- }
3911
-
3912
- export interface GetMenuOptionNutritionConsumerV2 {
3913
- calories?: GetMenuItemNutritionValueConsumerV2;
3914
- total_fat?: GetMenuItemNutritionValueConsumerV2;
3915
- saturated_fat?: GetMenuItemNutritionValueConsumerV2;
3916
- total_carbohydrate?: GetMenuItemNutritionValueConsumerV2;
3917
- total_sugars?: GetMenuItemNutritionValueConsumerV2;
3918
- protein?: GetMenuItemNutritionValueConsumerV2;
3919
- dietary_fiber?: GetMenuItemNutritionValueConsumerV2;
3920
- sodium?: GetMenuItemNutritionValueConsumerV2;
3921
- trans_fat?: GetMenuItemNutritionValueConsumerV2;
3922
- cholesterol?: GetMenuItemNutritionValueConsumerV2;
3923
- added_sugars?: GetMenuItemNutritionValueConsumerV2;
3924
- }
3925
-
3926
- export interface GetMenuItemPriceConsumerV2 {
3927
- amount?: number;
3928
- currency?: string;
3929
- total_price?: number;
3930
- discount?: number;
3931
- }
3932
-
3933
- export interface GetMenuItemImageSizesConsumerV2 {
3934
- original?: string;
3935
- thumbnail_80_80?: string;
3936
- }
3937
-
3938
- export interface GetMenuItemImageConsumerV2 {
3939
- src?: string;
3940
- sizes?: GetMenuItemImageSizesConsumerV2;
3941
- }
3942
-
3943
- export interface GetMenuItemCertifiedConsumerV2 {
3944
- vegan?: boolean;
3945
- vegetarian?: boolean;
3946
- seafood_watch?: boolean;
3947
- wellbeing?: boolean;
3948
- farm_to_fork?: boolean;
3949
- in_balance?: boolean;
3950
- organic?: boolean;
3951
- no_gluten_ingredients?: boolean;
3952
- halal?: boolean;
3953
- kosher?: boolean;
3954
- humane?: boolean;
3955
- locally_crafted?: boolean;
3956
- nuts?: boolean;
3957
- oracle_garden_grown?: boolean;
3958
- oracle_oyes?: boolean;
3959
- peanut_free?: boolean;
3960
- tree_nut_free?: boolean;
3961
- wheat_free?: boolean;
3962
- non_gmo?: boolean;
3963
- milk_free?: boolean;
3964
- egg_free?: boolean;
3965
- soy_free?: boolean;
3966
- fair_trade?: boolean;
3967
- rainforest_alliance?: boolean;
3968
- salt_free?: boolean;
3969
- }
3970
-
3971
- export interface GetMenuItemReportingConsumerV2 {
3972
- category?: {
3973
- primary?: string;
3974
- secondary?: string;
3975
- };
3976
- jde_category?: string;
3977
- }
3978
-
3979
- export interface GetMenuItemIsConsumerV2 {
3980
- disabled?: boolean;
3981
- hidden?: boolean;
3982
- meq_eligible?: boolean;
3983
- out_of_stock?: boolean;
3984
- deleted?: boolean;
3985
- featured?: boolean;
3986
- }
3987
-
3988
- export interface GetMenuItemMenuLabelConsumerV2 {
3989
- id?: string;
3990
- text?: string;
3991
- s3_link?: string;
3992
- }
3993
-
3994
- export interface GetMenuItemOptionMetaConsumerV2 {
3995
- sizing?: {
3996
- name?: string;
3997
- posid?: string;
3998
- price?: number;
3999
- }[];
4000
- sort_number?: number;
4001
- menu_sort_number?: number;
4002
- unique_id?: number;
4003
- tax?: {
4004
- tax_tag_code?: string;
4005
- };
4006
- }
4007
-
4008
- export interface GetMenuItemOptionIsConsumerV2 {
4009
- disabled?: boolean;
4010
- hidden?: boolean;
4011
- out_of_stock?: boolean;
4012
- }
4013
-
4014
- export interface GetMenuItemOptionConsumerV2 {
4015
- id?: string;
4016
- label?: {
4017
- en?: string;
4018
- };
4019
- name?: string;
4020
- description?: {
4021
- en?: string;
4022
- };
4023
- price?: GetMenuItemPriceConsumerV2;
4024
- nutrition?: GetMenuOptionNutritionConsumerV2;
4025
- meta?: GetMenuItemOptionMetaConsumerV2;
4026
- image?: GetMenuItemImageConsumerV2;
4027
- certified?: GetMenuItemCertifiedConsumerV2;
4028
- is?: GetMenuItemOptionIsConsumerV2;
4029
- reporting?: GetMenuItemReportingConsumerV2;
4030
- sku?: number;
4031
- weight?: {
4032
- unit?: string;
4033
- amount?: number;
4034
- };
4035
- line_route?: string;
4036
- amount_off_exclusions?: string[];
4037
- }
4038
-
4039
- export interface GetMenuItemGroupIsConsumerV2 {
4040
- incremental?: boolean;
4367
+ comment?: string;
4368
+ reason?: [];
4041
4369
  }
4042
4370
 
4043
- export interface GetMenuItemGroupMetaConsumerV2 {
4044
- order_type?: 'selection' | 'option' | 'quantity';
4045
- sort_number?: number;
4046
- menu_sort_number?: number;
4047
- surcharge_limit_value?: number;
4371
+ export interface GetReviewOrderItemsRequestDTO {
4372
+ reviews: ReviewDTO[];
4048
4373
  }
4049
4374
 
4050
- export interface GetMenuItemOptionsGroupConsumerV2 {
4051
- id?: string;
4052
- label?: {
4053
- en?: string;
4054
- };
4055
- items?: GetMenuItemOptionConsumerV2[];
4056
- min?: number;
4057
- max?: number;
4058
- is?: GetMenuItemGroupIsConsumerV2;
4059
- meta?: GetMenuItemGroupMetaConsumerV2;
4375
+ export interface PostConsumerShoppingCartBulkBodyRequest {
4376
+ // ids of the shopping carts to get
4377
+ ids: string[];
4060
4378
  }
4061
4379
 
4062
- export interface GetMenuItemRecipeConsumerV2 {
4063
- smart_tags?: string[];
4064
- allergen_tags?: string[];
4065
- mrn?: string;
4066
- unit_id?: string;
4067
- portion_quantity?: number;
4068
- portion_unit_name?: string;
4069
- grams?: number;
4070
- cost?: number;
4071
- ingredients?: string[];
4380
+ export interface PostConsumerShoppingCartBulkResponse {
4381
+ // shopping carts
4382
+ shoppingcarts: PostConsumerShoppingCartResponse[];
4072
4383
  }
4073
4384
 
4074
- export interface GetMenuItemMetaConsumerV2 {
4075
- barcodes?: string[];
4076
- recipe?: GetMenuItemRecipeConsumerV2;
4077
- superplate?: {
4078
- type_id?: number;
4079
- type?: string;
4080
- };
4081
- sort_number?: number;
4082
- menu_sort_number?: number;
4083
- unique_id?: number;
4084
- tax?: {
4085
- tax_tag_code?: string;
4086
- tax_jwo_code?: string;
4087
- tax_rate?: number;
4088
- tax_amount?: number;
4089
- };
4385
+ export interface ConsumerDeleteMealplanBody {
4386
+ // mealplan tenders to delete
4387
+ tenders?: string[];
4090
4388
  }
4091
4389
 
4092
- export interface GetMenuItemConsumerV2 {
4093
- id?: string;
4094
- label?: {
4095
- en?: string;
4096
- };
4097
- name?: string;
4098
- description?: {
4099
- en?: string;
4100
- };
4101
- price?: GetMenuItemPriceConsumerV2;
4102
- meal_value?: number;
4103
- sale_price?: GetMenuItemPriceConsumerV2;
4104
- unit?: number;
4105
- sku?: number;
4106
- item_number?: number;
4107
- parent_id?: string;
4108
- location?: string;
4109
- line_route?: string;
4110
- weight?: {
4111
- unit?: string;
4112
- amount?: number;
4113
- };
4114
- category?: {
4115
- en?: string;
4116
- };
4117
- ingredients?: Record<string, any>[];
4118
- amount_off_exclusions?: string[];
4119
- nutrition?: GetMenuItemNutritionConsumerV2;
4120
- certified?: GetMenuItemCertifiedConsumerV2;
4121
- options?: GetMenuItemOptionsGroupConsumerV2[];
4122
- meta?: GetMenuItemMetaConsumerV2;
4123
- image?: GetMenuItemImageConsumerV2;
4124
- is?: GetMenuItemIsConsumerV2;
4125
- menu_labels?: GetMenuItemMenuLabelConsumerV2[];
4126
- reporting?: GetMenuItemReportingConsumerV2;
4390
+ export interface PostExternalExchangeLoginCodeRequestDTO {
4391
+ // One-time code from the app login link
4392
+ code: string;
4127
4393
  }
4128
4394
 
4129
- export interface GetMenuGroupConsumerV2 {
4130
- id: string;
4131
- label?: {
4132
- en?: string;
4133
- fr?: string;
4134
- };
4135
- items?: GetMenuItemConsumerV2[];
4395
+ export interface AccessTokenPartDTO {
4396
+ token: string;
4397
+ expires: string;
4136
4398
  }
4137
4399
 
4138
- export interface GetMenuIsConsumerV2 {
4139
- disabled?: boolean;
4140
- hidden?: boolean;
4141
- linked?: boolean;
4142
- promo_exemptions_enabled?: boolean;
4143
- plu_enabled?: boolean;
4144
- item_images_enabled?: boolean;
4145
- item_showcase_enabled?: boolean;
4146
- item_desc_edit_enabled?: boolean;
4147
- calories_edit_enabled?: boolean;
4148
- item_label_edit_enabled?: boolean;
4149
- frictionless?: boolean;
4150
- category_images_enabled?: boolean;
4400
+ export interface ProfileNameDTO {
4401
+ first: string;
4402
+ last: string;
4151
4403
  }
4152
4404
 
4153
- export interface GetMenuMetaConsumerV2 {
4154
- locked_by_user?: string;
4155
- last_modified_user?: string;
4156
- centricos?: boolean;
4157
- version?: number;
4158
- revision?: string;
4405
+ export interface ProfileDateDTO {
4406
+ modified?: string;
4407
+ created?: string;
4159
4408
  }
4160
4409
 
4161
- export interface GetMenuDateConsumerV2 {
4162
- created?: string;
4163
- modified?: string;
4164
- published?: string;
4410
+ export interface ProfileIsDTO {
4411
+ disabled: boolean;
4412
+ verified: boolean;
4165
4413
  }
4166
4414
 
4167
- export interface GetMenuImageSizesConsumerV2 {
4168
- original?: string;
4169
- thumbnail_80_80?: string;
4415
+ export interface ExchangeProfileDTO {
4416
+ id: string;
4417
+ email: string;
4418
+ name?: ProfileNameDTO;
4419
+ date?: ProfileDateDTO;
4420
+ is?: ProfileIsDTO;
4421
+ // Additional user metadata
4422
+ meta?: Record<string, any>;
4170
4423
  }
4171
4424
 
4172
- export interface GetMenuImageConsumerV2 {
4173
- src?: string;
4174
- sizes?: GetMenuImageSizesConsumerV2;
4425
+ export interface PostExternalExchangeLoginCodeResponseDTO {
4426
+ access: AccessTokenPartDTO;
4427
+ profile: ExchangeProfileDTO;
4175
4428
  }
4176
4429
 
4177
- export interface GetMenuResponseConsumerV2 {
4430
+ export interface GetConsumerLocationResponse {
4431
+ // id
4178
4432
  id: string;
4433
+ date?: {
4434
+ created?: string;
4435
+ modified?: string;
4436
+ };
4437
+ // name
4438
+ name: string;
4179
4439
  label?: {
4180
4440
  en?: string;
4441
+ fr?: string;
4181
4442
  };
4182
- groups?: GetMenuGroupConsumerV2[];
4183
- parent_id?: string;
4184
- location_brand?: string;
4185
- company?: string;
4186
- sector?: string;
4187
- date?: GetMenuDateConsumerV2;
4188
- is?: GetMenuIsConsumerV2;
4189
- meta?: GetMenuMetaConsumerV2;
4190
- image?: GetMenuImageConsumerV2;
4191
- }
4192
-
4193
- export interface Certified {
4194
- // Certified vegan
4195
- vegan?: boolean;
4196
- // Certified vegetarian
4197
- vegetarian?: boolean;
4198
- // Seafood Watch certified (sustainable seafood)
4199
- seafood_watch?: boolean;
4200
- // Certified for general wellbeing
4201
- wellbeing?: boolean;
4202
- // Farm to Fork certified (locally sourced)
4203
- farm_to_fork?: boolean;
4204
- // In Balance certified (nutritionally balanced)
4205
- in_balance?: boolean;
4206
- // Certified organic
4207
- organic?: boolean;
4208
- // No gluten ingredients present
4209
- no_gluten_ingredients?: boolean;
4210
- // Certified halal
4211
- halal?: boolean;
4212
- // Certified kosher
4213
- kosher?: boolean;
4214
- // Certified humane (animal welfare)
4215
- humane?: boolean;
4216
- // Locally crafted product
4217
- locally_crafted?: boolean;
4218
- // Contains nuts
4219
- nuts?: boolean;
4220
- // Oracle Garden Grown certified
4221
- oracle_garden_grown?: boolean;
4222
- // Oracle OYES certified
4223
- oracle_oyes?: boolean;
4224
- // Peanut free
4225
- peanut_free?: boolean;
4226
- // Tree nut free
4227
- tree_nut_free?: boolean;
4228
- // Wheat free
4229
- wheat_free?: boolean;
4230
- // Non-GMO certified
4231
- non_gmo?: boolean;
4232
- // Milk free
4233
- milk_free?: boolean;
4234
- // Egg free
4235
- egg_free?: boolean;
4236
- // Soy free
4237
- soy_free?: boolean;
4238
- // Fair Trade certified
4239
- fair_trade?: boolean;
4240
- // Rainforest Alliance certified
4241
- rainforest_alliance?: boolean;
4242
- // Salt free
4243
- salt_free?: boolean;
4443
+ // distance in meters from the group
4444
+ distance?: number;
4445
+ // meta data
4446
+ meta?: Record<string, any>;
4447
+ style?: {
4448
+ logo?: string | null;
4449
+ main_logo?: string | null;
4450
+ alt_logo?: string | null;
4451
+ };
4452
+ // timezone
4453
+ timezone?: string;
4454
+ // site operational status
4455
+ status?: Record<string, any>;
4456
+ locations?: ConsumerLocation[];
4457
+ address?: ConsumerAddress;
4244
4458
  }
4245
4459
 
4246
4460
  // GET /consumer/v1/health-check
@@ -4506,6 +4720,15 @@ export interface GetConsumerMenuPath {
4506
4720
 
4507
4721
  export type GetConsumerMenuResponse = GetMenuResponseConsumer;
4508
4722
 
4723
+ // GET /consumer/v2/menu/{id} - Get full Menu by ID (v2)
4724
+
4725
+ export interface GetConsumerMenuV2Path {
4726
+ // Menu ID as Encoded CDL ID
4727
+ id: string;
4728
+ }
4729
+
4730
+ export type GetConsumerMenuV2Response = GetMenuResponseConsumerV2;
4731
+
4509
4732
  // GET /consumer/menu/{id}/items - Provide the front end with menu items
4510
4733
 
4511
4734
  export interface GetConsumerMenuItemsPath {
@@ -5080,12 +5303,3 @@ export interface GetConsumerLocationQuery {
5080
5303
  }
5081
5304
 
5082
5305
  export type GetConsumerLocationResponse$0 = GetConsumerLocationResponse;
5083
-
5084
- // GET /consumer/v2/menu/{id} - Get full Menu by ID (v2)
5085
-
5086
- export interface GetConsumerMenuV2Path {
5087
- // Menu ID as Encoded CDL ID
5088
- id: string;
5089
- }
5090
-
5091
- export type GetConsumerMenuV2Response = GetMenuResponseConsumerV2;