@compassdigital/sdk.typescript 4.617.0 → 4.619.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.
@@ -1319,7 +1319,6 @@ export interface ConsumerDiscountDTO {
1319
1319
  is?: ConsumerDiscountIs;
1320
1320
  meta?: ConsumerDiscountMeta;
1321
1321
  channelConfig: ConsumerDiscountChannelConfig;
1322
- appliesTo: Record<string, any>;
1323
1322
  type: Record<string, any>;
1324
1323
  }
1325
1324
 
@@ -1802,7 +1801,14 @@ export interface ConsumerItem {
1802
1801
  primary?: string;
1803
1802
  secondary?: string;
1804
1803
  };
1804
+ jde_category?: string;
1805
1805
  };
1806
+ parent_id?: string;
1807
+ menu_labels?: {
1808
+ id?: string;
1809
+ text?: string;
1810
+ s3_link?: string;
1811
+ }[];
1806
1812
  is_deleted?: boolean;
1807
1813
  is?: {
1808
1814
  disabled?: boolean;
@@ -1857,90 +1863,23 @@ export interface GetMenuItemNutritionConsumer {
1857
1863
  calories?: GetMenuItemNutritionValueConsumer;
1858
1864
  }
1859
1865
 
1860
- export interface Certified {
1861
- // Certified vegan
1862
- vegan?: boolean;
1863
- // Certified vegetarian
1864
- vegetarian?: boolean;
1865
- // Seafood Watch certified (sustainable seafood)
1866
- seafood_watch?: boolean;
1867
- // Certified for general wellbeing
1868
- wellbeing?: boolean;
1869
- // Farm to Fork certified (locally sourced)
1870
- farm_to_fork?: boolean;
1871
- // In Balance certified (nutritionally balanced)
1872
- in_balance?: boolean;
1873
- // Certified organic
1874
- organic?: boolean;
1875
- // No gluten ingredients present
1876
- no_gluten_ingredients?: boolean;
1877
- // Certified halal
1878
- halal?: boolean;
1879
- // Certified kosher
1880
- kosher?: boolean;
1881
- // Certified humane (animal welfare)
1882
- humane?: boolean;
1883
- // Locally crafted product
1884
- locally_crafted?: boolean;
1885
- // Contains nuts
1886
- nuts?: boolean;
1887
- // Oracle Garden Grown certified
1888
- oracle_garden_grown?: boolean;
1889
- // Oracle OYES certified
1890
- oracle_oyes?: boolean;
1891
- // Peanut free
1892
- peanut_free?: boolean;
1893
- // Tree nut free
1894
- tree_nut_free?: boolean;
1895
- // Wheat free
1896
- wheat_free?: boolean;
1897
- // Non-GMO certified
1898
- non_gmo?: boolean;
1899
- // Milk free
1900
- milk_free?: boolean;
1901
- // Egg free
1902
- egg_free?: boolean;
1903
- // Soy free
1904
- soy_free?: boolean;
1905
- // Fair Trade certified
1906
- fair_trade?: boolean;
1907
- // Rainforest Alliance certified
1908
- rainforest_alliance?: boolean;
1909
- // Salt free
1910
- salt_free?: boolean;
1911
- }
1912
-
1913
1866
  export interface GetMenuOptionNutritionConsumer {
1914
- // Calories
1915
1867
  calories?: GetMenuItemNutritionValueConsumer;
1916
- // Total fat
1917
1868
  total_fat?: GetMenuItemNutritionValueConsumer;
1918
- // Saturated fat
1919
1869
  saturated_fat?: GetMenuItemNutritionValueConsumer;
1920
- // Total carbohydrates
1921
1870
  total_carbohydrate?: GetMenuItemNutritionValueConsumer;
1922
- // Total sugars
1923
1871
  total_sugars?: GetMenuItemNutritionValueConsumer;
1924
- // Protein
1925
1872
  protein?: GetMenuItemNutritionValueConsumer;
1926
- // Dietary fiber
1927
1873
  dietary_fiber?: GetMenuItemNutritionValueConsumer;
1928
- // Sodium
1929
1874
  sodium?: GetMenuItemNutritionValueConsumer;
1930
- // Trans fat
1931
1875
  trans_fat?: GetMenuItemNutritionValueConsumer;
1932
- // Cholesterol
1933
1876
  cholesterol?: GetMenuItemNutritionValueConsumer;
1934
- // Added sugars
1935
1877
  added_sugars?: GetMenuItemNutritionValueConsumer;
1936
1878
  }
1937
1879
 
1938
1880
  export interface GetMenuItemOptionSizingConsumer {
1939
- // Sizing name
1940
1881
  name?: string;
1941
- // POS ID for sizing
1942
1882
  posid?: string;
1943
- // Price for this sizing
1944
1883
  price?: number;
1945
1884
  }
1946
1885
 
@@ -1949,6 +1888,16 @@ export interface GetMenuItemOptionMetaConsumer {
1949
1888
  sizing?: GetMenuItemOptionSizingConsumer[];
1950
1889
  }
1951
1890
 
1891
+ export interface GetMenuItemImageSizesConsumer {
1892
+ original?: string;
1893
+ thumbnail_80_80?: string;
1894
+ }
1895
+
1896
+ export interface GetMenuItemImageConsumer {
1897
+ src?: string;
1898
+ sizes?: GetMenuItemImageSizesConsumer;
1899
+ }
1900
+
1952
1901
  export interface GetMenuItemOptionConsumer {
1953
1902
  // Menu Option ID
1954
1903
  id?: string;
@@ -1963,7 +1912,6 @@ export interface GetMenuItemOptionConsumer {
1963
1912
  }
1964
1913
 
1965
1914
  export interface GetMenuItemGroupIsConsumer {
1966
- // Options group incremental?
1967
1915
  incremental?: boolean;
1968
1916
  }
1969
1917
 
@@ -1975,17 +1923,11 @@ export interface GetMenuItemGroupMetaConsumer {
1975
1923
  export interface GetMenuItemOptionsGroupConsumer {
1976
1924
  // Menu Options Group ID
1977
1925
  id?: string;
1978
- // Label for the options group
1979
1926
  label?: GetMenuItemLabelConsumer;
1980
- // Options group items
1981
1927
  items?: GetMenuItemOptionConsumer[];
1982
- // Minimum number of options
1983
1928
  min?: number;
1984
- // Maximum number of options
1985
1929
  max?: number;
1986
- // Object containing quick boolean details
1987
1930
  is?: GetMenuItemGroupIsConsumer;
1988
- // Metadata for the options group
1989
1931
  meta?: GetMenuItemGroupMetaConsumer;
1990
1932
  }
1991
1933
 
@@ -2003,31 +1945,14 @@ export interface GetMenuItemMetaConsumer {
2003
1945
  recipe?: GetMenuItemRecipeConsumer;
2004
1946
  }
2005
1947
 
2006
- export interface GetMenuItemImageSizesConsumer {
2007
- // Image URL
2008
- original?: string;
2009
- // 80x80 thumbnail image URL
2010
- thumbnail_80_80?: string;
2011
- }
2012
-
2013
- export interface GetMenuItemImageConsumer {
2014
- // Image source URL
2015
- src?: string;
2016
- // Image sizes
2017
- sizes?: GetMenuItemImageSizesConsumer;
2018
- }
2019
-
2020
1948
  export interface GetMenuItemIsConsumer {
2021
1949
  // Is the item out of stock?
2022
1950
  out_of_stock?: boolean;
2023
1951
  }
2024
1952
 
2025
1953
  export interface GetMenuItemMenuLabelConsumer {
2026
- // Menu label ID
2027
1954
  id?: string;
2028
- // Menu label text
2029
1955
  text?: string;
2030
- // Image for Menu label S3 link
2031
1956
  s3_link?: string;
2032
1957
  }
2033
1958
 
@@ -3792,6 +3717,363 @@ export interface GetConsumerLocationResponse {
3792
3717
  address?: ConsumerAddress;
3793
3718
  }
3794
3719
 
3720
+ export interface GetMenuItemNutritionValueConsumerV2 {
3721
+ amount?: number;
3722
+ unit?: string;
3723
+ display?: string;
3724
+ }
3725
+
3726
+ export interface GetMenuItemNutritionConsumerV2 {
3727
+ kcal?: number;
3728
+ calories?: GetMenuItemNutritionValueConsumerV2;
3729
+ serving_size?: GetMenuItemNutritionValueConsumerV2;
3730
+ total_fat?: GetMenuItemNutritionValueConsumerV2;
3731
+ saturated_fat?: GetMenuItemNutritionValueConsumerV2;
3732
+ trans_fat?: GetMenuItemNutritionValueConsumerV2;
3733
+ cholesterol?: GetMenuItemNutritionValueConsumerV2;
3734
+ sodium?: GetMenuItemNutritionValueConsumerV2;
3735
+ total_carbohydrate?: GetMenuItemNutritionValueConsumerV2;
3736
+ dietary_fiber?: GetMenuItemNutritionValueConsumerV2;
3737
+ sugars?: GetMenuItemNutritionValueConsumerV2;
3738
+ total_sugars?: GetMenuItemNutritionValueConsumerV2;
3739
+ protein?: GetMenuItemNutritionValueConsumerV2;
3740
+ well_being?: GetMenuItemNutritionValueConsumerV2;
3741
+ }
3742
+
3743
+ export interface GetMenuOptionNutritionConsumerV2 {
3744
+ calories?: GetMenuItemNutritionValueConsumerV2;
3745
+ total_fat?: GetMenuItemNutritionValueConsumerV2;
3746
+ saturated_fat?: GetMenuItemNutritionValueConsumerV2;
3747
+ total_carbohydrate?: GetMenuItemNutritionValueConsumerV2;
3748
+ total_sugars?: GetMenuItemNutritionValueConsumerV2;
3749
+ protein?: GetMenuItemNutritionValueConsumerV2;
3750
+ dietary_fiber?: GetMenuItemNutritionValueConsumerV2;
3751
+ sodium?: GetMenuItemNutritionValueConsumerV2;
3752
+ trans_fat?: GetMenuItemNutritionValueConsumerV2;
3753
+ cholesterol?: GetMenuItemNutritionValueConsumerV2;
3754
+ added_sugars?: GetMenuItemNutritionValueConsumerV2;
3755
+ }
3756
+
3757
+ export interface GetMenuItemPriceConsumerV2 {
3758
+ amount?: number;
3759
+ currency?: string;
3760
+ total_price?: number;
3761
+ discount?: number;
3762
+ }
3763
+
3764
+ export interface GetMenuItemImageSizesConsumerV2 {
3765
+ original?: string;
3766
+ thumbnail_80_80?: string;
3767
+ }
3768
+
3769
+ export interface GetMenuItemImageConsumerV2 {
3770
+ src?: string;
3771
+ sizes?: GetMenuItemImageSizesConsumerV2;
3772
+ }
3773
+
3774
+ export interface GetMenuItemCertifiedConsumerV2 {
3775
+ vegan?: boolean;
3776
+ vegetarian?: boolean;
3777
+ seafood_watch?: boolean;
3778
+ wellbeing?: boolean;
3779
+ farm_to_fork?: boolean;
3780
+ in_balance?: boolean;
3781
+ organic?: boolean;
3782
+ no_gluten_ingredients?: boolean;
3783
+ halal?: boolean;
3784
+ kosher?: boolean;
3785
+ humane?: boolean;
3786
+ locally_crafted?: boolean;
3787
+ nuts?: boolean;
3788
+ oracle_garden_grown?: boolean;
3789
+ oracle_oyes?: boolean;
3790
+ peanut_free?: boolean;
3791
+ tree_nut_free?: boolean;
3792
+ wheat_free?: boolean;
3793
+ non_gmo?: boolean;
3794
+ milk_free?: boolean;
3795
+ egg_free?: boolean;
3796
+ soy_free?: boolean;
3797
+ fair_trade?: boolean;
3798
+ rainforest_alliance?: boolean;
3799
+ salt_free?: boolean;
3800
+ }
3801
+
3802
+ export interface GetMenuItemReportingConsumerV2 {
3803
+ category?: {
3804
+ primary?: string;
3805
+ secondary?: string;
3806
+ };
3807
+ jde_category?: string;
3808
+ }
3809
+
3810
+ export interface GetMenuItemIsConsumerV2 {
3811
+ disabled?: boolean;
3812
+ hidden?: boolean;
3813
+ meq_eligible?: boolean;
3814
+ out_of_stock?: boolean;
3815
+ deleted?: boolean;
3816
+ featured?: boolean;
3817
+ }
3818
+
3819
+ export interface GetMenuItemMenuLabelConsumerV2 {
3820
+ id?: string;
3821
+ text?: string;
3822
+ s3_link?: string;
3823
+ }
3824
+
3825
+ export interface GetMenuItemOptionMetaConsumerV2 {
3826
+ sizing?: {
3827
+ name?: string;
3828
+ posid?: string;
3829
+ price?: number;
3830
+ }[];
3831
+ sort_number?: number;
3832
+ menu_sort_number?: number;
3833
+ unique_id?: number;
3834
+ tax?: {
3835
+ tax_tag_code?: string;
3836
+ };
3837
+ }
3838
+
3839
+ export interface GetMenuItemOptionIsConsumerV2 {
3840
+ disabled?: boolean;
3841
+ hidden?: boolean;
3842
+ out_of_stock?: boolean;
3843
+ }
3844
+
3845
+ export interface GetMenuItemOptionConsumerV2 {
3846
+ id?: string;
3847
+ label?: {
3848
+ en?: string;
3849
+ };
3850
+ name?: string;
3851
+ description?: {
3852
+ en?: string;
3853
+ };
3854
+ price?: GetMenuItemPriceConsumerV2;
3855
+ nutrition?: GetMenuOptionNutritionConsumerV2;
3856
+ meta?: GetMenuItemOptionMetaConsumerV2;
3857
+ image?: GetMenuItemImageConsumerV2;
3858
+ certified?: GetMenuItemCertifiedConsumerV2;
3859
+ is?: GetMenuItemOptionIsConsumerV2;
3860
+ reporting?: GetMenuItemReportingConsumerV2;
3861
+ sku?: number;
3862
+ weight?: {
3863
+ unit?: string;
3864
+ amount?: number;
3865
+ };
3866
+ line_route?: string;
3867
+ amount_off_exclusions?: string[];
3868
+ }
3869
+
3870
+ export interface GetMenuItemGroupIsConsumerV2 {
3871
+ incremental?: boolean;
3872
+ }
3873
+
3874
+ export interface GetMenuItemGroupMetaConsumerV2 {
3875
+ order_type?: 'selection' | 'option' | 'quantity';
3876
+ sort_number?: number;
3877
+ menu_sort_number?: number;
3878
+ surcharge_limit_value?: number;
3879
+ }
3880
+
3881
+ export interface GetMenuItemOptionsGroupConsumerV2 {
3882
+ id?: string;
3883
+ label?: {
3884
+ en?: string;
3885
+ };
3886
+ items?: GetMenuItemOptionConsumerV2[];
3887
+ min?: number;
3888
+ max?: number;
3889
+ is?: GetMenuItemGroupIsConsumerV2;
3890
+ meta?: GetMenuItemGroupMetaConsumerV2;
3891
+ }
3892
+
3893
+ export interface GetMenuItemRecipeConsumerV2 {
3894
+ smart_tags?: string[];
3895
+ allergen_tags?: string[];
3896
+ mrn?: string;
3897
+ unit_id?: string;
3898
+ portion_quantity?: number;
3899
+ portion_unit_name?: string;
3900
+ grams?: number;
3901
+ cost?: number;
3902
+ ingredients?: string[];
3903
+ }
3904
+
3905
+ export interface GetMenuItemMetaConsumerV2 {
3906
+ barcodes?: string[];
3907
+ recipe?: GetMenuItemRecipeConsumerV2;
3908
+ superplate?: {
3909
+ type_id?: number;
3910
+ type?: string;
3911
+ };
3912
+ sort_number?: number;
3913
+ menu_sort_number?: number;
3914
+ unique_id?: number;
3915
+ tax?: {
3916
+ tax_tag_code?: string;
3917
+ tax_jwo_code?: string;
3918
+ tax_rate?: number;
3919
+ tax_amount?: number;
3920
+ };
3921
+ }
3922
+
3923
+ export interface GetMenuItemConsumerV2 {
3924
+ id?: string;
3925
+ label?: {
3926
+ en?: string;
3927
+ };
3928
+ name?: string;
3929
+ description?: {
3930
+ en?: string;
3931
+ };
3932
+ price?: GetMenuItemPriceConsumerV2;
3933
+ meal_value?: number;
3934
+ sale_price?: GetMenuItemPriceConsumerV2;
3935
+ unit?: number;
3936
+ sku?: number;
3937
+ item_number?: number;
3938
+ parent_id?: string;
3939
+ location?: string;
3940
+ line_route?: string;
3941
+ weight?: {
3942
+ unit?: string;
3943
+ amount?: number;
3944
+ };
3945
+ category?: {
3946
+ en?: string;
3947
+ };
3948
+ ingredients?: Record<string, any>[];
3949
+ amount_off_exclusions?: string[];
3950
+ nutrition?: GetMenuItemNutritionConsumerV2;
3951
+ certified?: GetMenuItemCertifiedConsumerV2;
3952
+ options?: GetMenuItemOptionsGroupConsumerV2[];
3953
+ meta?: GetMenuItemMetaConsumerV2;
3954
+ image?: GetMenuItemImageConsumerV2;
3955
+ is?: GetMenuItemIsConsumerV2;
3956
+ menu_labels?: GetMenuItemMenuLabelConsumerV2[];
3957
+ reporting?: GetMenuItemReportingConsumerV2;
3958
+ }
3959
+
3960
+ export interface GetMenuGroupConsumerV2 {
3961
+ id: string;
3962
+ label?: {
3963
+ en?: string;
3964
+ fr?: string;
3965
+ };
3966
+ items?: GetMenuItemConsumerV2[];
3967
+ }
3968
+
3969
+ export interface GetMenuIsConsumerV2 {
3970
+ disabled?: boolean;
3971
+ hidden?: boolean;
3972
+ linked?: boolean;
3973
+ promo_exemptions_enabled?: boolean;
3974
+ plu_enabled?: boolean;
3975
+ item_images_enabled?: boolean;
3976
+ item_showcase_enabled?: boolean;
3977
+ item_desc_edit_enabled?: boolean;
3978
+ calories_edit_enabled?: boolean;
3979
+ item_label_edit_enabled?: boolean;
3980
+ frictionless?: boolean;
3981
+ category_images_enabled?: boolean;
3982
+ }
3983
+
3984
+ export interface GetMenuMetaConsumerV2 {
3985
+ locked_by_user?: string;
3986
+ last_modified_user?: string;
3987
+ centricos?: boolean;
3988
+ version?: number;
3989
+ revision?: string;
3990
+ }
3991
+
3992
+ export interface GetMenuDateConsumerV2 {
3993
+ created?: string;
3994
+ modified?: string;
3995
+ published?: string;
3996
+ }
3997
+
3998
+ export interface GetMenuImageSizesConsumerV2 {
3999
+ original?: string;
4000
+ thumbnail_80_80?: string;
4001
+ }
4002
+
4003
+ export interface GetMenuImageConsumerV2 {
4004
+ src?: string;
4005
+ sizes?: GetMenuImageSizesConsumerV2;
4006
+ }
4007
+
4008
+ export interface GetMenuResponseConsumerV2 {
4009
+ id: string;
4010
+ label?: {
4011
+ en?: string;
4012
+ };
4013
+ groups?: GetMenuGroupConsumerV2[];
4014
+ parent_id?: string;
4015
+ location_brand?: string;
4016
+ company?: string;
4017
+ sector?: string;
4018
+ date?: GetMenuDateConsumerV2;
4019
+ is?: GetMenuIsConsumerV2;
4020
+ meta?: GetMenuMetaConsumerV2;
4021
+ image?: GetMenuImageConsumerV2;
4022
+ }
4023
+
4024
+ export interface Certified {
4025
+ // Certified vegan
4026
+ vegan?: boolean;
4027
+ // Certified vegetarian
4028
+ vegetarian?: boolean;
4029
+ // Seafood Watch certified (sustainable seafood)
4030
+ seafood_watch?: boolean;
4031
+ // Certified for general wellbeing
4032
+ wellbeing?: boolean;
4033
+ // Farm to Fork certified (locally sourced)
4034
+ farm_to_fork?: boolean;
4035
+ // In Balance certified (nutritionally balanced)
4036
+ in_balance?: boolean;
4037
+ // Certified organic
4038
+ organic?: boolean;
4039
+ // No gluten ingredients present
4040
+ no_gluten_ingredients?: boolean;
4041
+ // Certified halal
4042
+ halal?: boolean;
4043
+ // Certified kosher
4044
+ kosher?: boolean;
4045
+ // Certified humane (animal welfare)
4046
+ humane?: boolean;
4047
+ // Locally crafted product
4048
+ locally_crafted?: boolean;
4049
+ // Contains nuts
4050
+ nuts?: boolean;
4051
+ // Oracle Garden Grown certified
4052
+ oracle_garden_grown?: boolean;
4053
+ // Oracle OYES certified
4054
+ oracle_oyes?: boolean;
4055
+ // Peanut free
4056
+ peanut_free?: boolean;
4057
+ // Tree nut free
4058
+ tree_nut_free?: boolean;
4059
+ // Wheat free
4060
+ wheat_free?: boolean;
4061
+ // Non-GMO certified
4062
+ non_gmo?: boolean;
4063
+ // Milk free
4064
+ milk_free?: boolean;
4065
+ // Egg free
4066
+ egg_free?: boolean;
4067
+ // Soy free
4068
+ soy_free?: boolean;
4069
+ // Fair Trade certified
4070
+ fair_trade?: boolean;
4071
+ // Rainforest Alliance certified
4072
+ rainforest_alliance?: boolean;
4073
+ // Salt free
4074
+ salt_free?: boolean;
4075
+ }
4076
+
3795
4077
  // GET /consumer/v1/health-check
3796
4078
 
3797
4079
  export type HealthCheckControllerExecuteResponse = {};
@@ -4611,3 +4893,12 @@ export interface GetConsumerLocationQuery {
4611
4893
  }
4612
4894
 
4613
4895
  export type GetConsumerLocationResponse$0 = GetConsumerLocationResponse;
4896
+
4897
+ // GET /consumer/v2/menu/{id} - Get full Menu by ID (v2)
4898
+
4899
+ export interface GetConsumerMenuV2Path {
4900
+ // Menu ID as Encoded CDL ID
4901
+ id: string;
4902
+ }
4903
+
4904
+ export type GetConsumerMenuV2Response = GetMenuResponseConsumerV2;