@compassdigital/sdk.typescript 4.800.0 → 4.802.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 +8 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +9 -0
- package/lib/index.js.map +1 -1
- package/lib/interface/consumer.d.ts +107 -0
- package/lib/interface/consumer.d.ts.map +1 -1
- package/lib/interface/menu.d.ts +5 -0
- package/lib/interface/menu.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +21 -0
- package/src/interface/consumer.ts +193 -0
- package/src/interface/menu.ts +6 -0
package/package.json
CHANGED
package/src/index.ts
CHANGED
|
@@ -1269,6 +1269,7 @@ import {
|
|
|
1269
1269
|
GetConsumerAllergensListResponse,
|
|
1270
1270
|
GetConsumerMenuResponse,
|
|
1271
1271
|
GetConsumerMenuV2Response,
|
|
1272
|
+
GetConsumerMenuV3Response,
|
|
1272
1273
|
GetConsumerMenuItemsQuery,
|
|
1273
1274
|
GetConsumerMenuItemsResponse$0,
|
|
1274
1275
|
PostConsumerLocationsMarketplaceTimeslotsQuery,
|
|
@@ -14844,6 +14845,26 @@ export class ServiceClient extends BaseServiceClient {
|
|
|
14844
14845
|
);
|
|
14845
14846
|
}
|
|
14846
14847
|
|
|
14848
|
+
/**
|
|
14849
|
+
* GET /consumer/v3/menu/{id} - Get full Menu by ID (v3)
|
|
14850
|
+
*
|
|
14851
|
+
* @param id - Menu ID as Encoded CDL ID
|
|
14852
|
+
* @param options - additional request options
|
|
14853
|
+
*/
|
|
14854
|
+
get_consumer_menu_v3(
|
|
14855
|
+
id: string,
|
|
14856
|
+
options?: RequestOptions,
|
|
14857
|
+
): ResponsePromise<GetConsumerMenuV3Response> {
|
|
14858
|
+
return this.request(
|
|
14859
|
+
'consumer',
|
|
14860
|
+
'/consumer/v3/menu/{id}',
|
|
14861
|
+
'GET',
|
|
14862
|
+
`/consumer/v3/menu/${id}`,
|
|
14863
|
+
null,
|
|
14864
|
+
options,
|
|
14865
|
+
);
|
|
14866
|
+
}
|
|
14867
|
+
|
|
14847
14868
|
/**
|
|
14848
14869
|
* GET /consumer/menu/{id}/items - Provide the front end with menu items
|
|
14849
14870
|
*
|
|
@@ -2769,6 +2769,190 @@ export interface GetMenuResponseConsumerV2 {
|
|
|
2769
2769
|
image?: GetMenuImageConsumerV2;
|
|
2770
2770
|
}
|
|
2771
2771
|
|
|
2772
|
+
export interface GetMenuLabelConsumerV3 {
|
|
2773
|
+
// English
|
|
2774
|
+
en?: string;
|
|
2775
|
+
}
|
|
2776
|
+
|
|
2777
|
+
export interface GetMenuGroupLabelConsumerV3 {
|
|
2778
|
+
// English
|
|
2779
|
+
en?: string;
|
|
2780
|
+
// French
|
|
2781
|
+
fr?: string;
|
|
2782
|
+
}
|
|
2783
|
+
|
|
2784
|
+
export interface GetMenuItemLabelConsumerV3 {
|
|
2785
|
+
// English
|
|
2786
|
+
en?: string;
|
|
2787
|
+
}
|
|
2788
|
+
|
|
2789
|
+
export interface GetMenuItemPriceConsumerV3 {
|
|
2790
|
+
// Amount
|
|
2791
|
+
amount?: number;
|
|
2792
|
+
}
|
|
2793
|
+
|
|
2794
|
+
export interface GetMenuItemNutrientConsumerV3 {
|
|
2795
|
+
// Nutrient key that matches FE keys for localization (e.g. total_fat, added_sugars)
|
|
2796
|
+
key: string;
|
|
2797
|
+
// Indent level for FDA label layout (0 = primary, 1 = sub-nutrient, 2 = sub-sub-nutrient)
|
|
2798
|
+
indent: number;
|
|
2799
|
+
// Numeric amount
|
|
2800
|
+
amount?: number;
|
|
2801
|
+
// Unit of measurement
|
|
2802
|
+
unit?: string;
|
|
2803
|
+
// Formatted display value (e.g. "8 g")
|
|
2804
|
+
display?: string;
|
|
2805
|
+
}
|
|
2806
|
+
|
|
2807
|
+
export interface GetMenuItemNutritionValueConsumerV3 {
|
|
2808
|
+
// Amount
|
|
2809
|
+
amount?: number;
|
|
2810
|
+
}
|
|
2811
|
+
|
|
2812
|
+
export interface GetMenuOptionNutritionConsumerV3 {
|
|
2813
|
+
// Calories
|
|
2814
|
+
calories?: GetMenuItemNutritionValueConsumerV3;
|
|
2815
|
+
}
|
|
2816
|
+
|
|
2817
|
+
export interface GetMenuItemOptionSizingConsumerV3 {
|
|
2818
|
+
// Sizing name
|
|
2819
|
+
name?: string;
|
|
2820
|
+
// POS ID for sizing
|
|
2821
|
+
posid?: string;
|
|
2822
|
+
// Price for this sizing
|
|
2823
|
+
price?: number;
|
|
2824
|
+
}
|
|
2825
|
+
|
|
2826
|
+
export interface GetMenuItemOptionMetaConsumerV3 {
|
|
2827
|
+
// Available sizings
|
|
2828
|
+
sizing?: GetMenuItemOptionSizingConsumerV3[];
|
|
2829
|
+
}
|
|
2830
|
+
|
|
2831
|
+
export interface GetMenuItemOptionConsumerV3 {
|
|
2832
|
+
// Menu Option ID
|
|
2833
|
+
id?: string;
|
|
2834
|
+
// Label for the option
|
|
2835
|
+
label?: GetMenuItemLabelConsumerV3;
|
|
2836
|
+
// Price
|
|
2837
|
+
price?: GetMenuItemPriceConsumerV3;
|
|
2838
|
+
// Nutrition information
|
|
2839
|
+
nutrition?: GetMenuOptionNutritionConsumerV3;
|
|
2840
|
+
// Metadata for the option
|
|
2841
|
+
meta?: GetMenuItemOptionMetaConsumerV3;
|
|
2842
|
+
}
|
|
2843
|
+
|
|
2844
|
+
export interface GetMenuItemGroupIsConsumerV3 {
|
|
2845
|
+
// Options group incremental
|
|
2846
|
+
incremental?: boolean;
|
|
2847
|
+
}
|
|
2848
|
+
|
|
2849
|
+
export interface GetMenuItemGroupMetaConsumerV3 {
|
|
2850
|
+
// Type of mod group
|
|
2851
|
+
order_type?: 'selection' | 'option' | 'quantity';
|
|
2852
|
+
}
|
|
2853
|
+
|
|
2854
|
+
export interface GetMenuItemOptionsGroupConsumerV3 {
|
|
2855
|
+
// Menu Options Group ID
|
|
2856
|
+
id?: string;
|
|
2857
|
+
// Label for the options group
|
|
2858
|
+
label?: GetMenuItemLabelConsumerV3;
|
|
2859
|
+
// Options group items
|
|
2860
|
+
items?: GetMenuItemOptionConsumerV3[];
|
|
2861
|
+
// Minimum number of options
|
|
2862
|
+
min?: number;
|
|
2863
|
+
// Maximum number of options
|
|
2864
|
+
max?: number;
|
|
2865
|
+
// Quick boolean details
|
|
2866
|
+
is?: GetMenuItemGroupIsConsumerV3;
|
|
2867
|
+
// Metadata for the options group
|
|
2868
|
+
meta?: GetMenuItemGroupMetaConsumerV3;
|
|
2869
|
+
}
|
|
2870
|
+
|
|
2871
|
+
export interface GetMenuItemRecipeConsumerV3 {
|
|
2872
|
+
// Smart tags
|
|
2873
|
+
smart_tags?: string[];
|
|
2874
|
+
// MenuWorks allergens with contains field, sorted by name
|
|
2875
|
+
allergens?: MenuRecipeAllergenConsumer[];
|
|
2876
|
+
}
|
|
2877
|
+
|
|
2878
|
+
export interface GetMenuItemMetaConsumerV3 {
|
|
2879
|
+
// Barcodes of the item
|
|
2880
|
+
barcodes?: string[];
|
|
2881
|
+
// Recipe metadata
|
|
2882
|
+
recipe?: GetMenuItemRecipeConsumerV3;
|
|
2883
|
+
}
|
|
2884
|
+
|
|
2885
|
+
export interface GetMenuItemImageSizesConsumerV3 {
|
|
2886
|
+
// 80x80 thumbnail image URL
|
|
2887
|
+
thumbnail_80_80?: string;
|
|
2888
|
+
}
|
|
2889
|
+
|
|
2890
|
+
export interface GetMenuItemImageConsumerV3 {
|
|
2891
|
+
// Image source URL
|
|
2892
|
+
src?: string;
|
|
2893
|
+
// Image sizes
|
|
2894
|
+
sizes?: GetMenuItemImageSizesConsumerV3;
|
|
2895
|
+
}
|
|
2896
|
+
|
|
2897
|
+
export interface GetMenuItemIsConsumerV3 {
|
|
2898
|
+
// Is the item out of stock
|
|
2899
|
+
out_of_stock?: boolean;
|
|
2900
|
+
}
|
|
2901
|
+
|
|
2902
|
+
export interface GetMenuItemMenuLabelConsumerV3 {
|
|
2903
|
+
// Menu label ID
|
|
2904
|
+
id?: string;
|
|
2905
|
+
// Menu label text
|
|
2906
|
+
text?: string;
|
|
2907
|
+
// Image for menu label S3 link
|
|
2908
|
+
s3_link?: string;
|
|
2909
|
+
}
|
|
2910
|
+
|
|
2911
|
+
export interface GetMenuItemConsumerV3 {
|
|
2912
|
+
// Menu Item ID
|
|
2913
|
+
id?: string;
|
|
2914
|
+
// Label for the menu item
|
|
2915
|
+
label?: GetMenuItemLabelConsumerV3;
|
|
2916
|
+
// Description of the item
|
|
2917
|
+
description?: GetMenuItemLabelConsumerV3;
|
|
2918
|
+
// Item price
|
|
2919
|
+
price?: GetMenuItemPriceConsumerV3;
|
|
2920
|
+
// Meal exchange value of the item
|
|
2921
|
+
meal_value?: number;
|
|
2922
|
+
// Number of units for the item
|
|
2923
|
+
unit?: number;
|
|
2924
|
+
// Ordered nutrition breakdown for display, following FDA Nutrition Facts label order and indentation
|
|
2925
|
+
ordered_nutrition?: GetMenuItemNutrientConsumerV3[];
|
|
2926
|
+
// Item options/modifiers
|
|
2927
|
+
options?: GetMenuItemOptionsGroupConsumerV3[];
|
|
2928
|
+
// Metadata for the item
|
|
2929
|
+
meta?: GetMenuItemMetaConsumerV3;
|
|
2930
|
+
// Item image data
|
|
2931
|
+
image?: GetMenuItemImageConsumerV3;
|
|
2932
|
+
// Quick boolean details
|
|
2933
|
+
is?: GetMenuItemIsConsumerV3;
|
|
2934
|
+
// Menu labels
|
|
2935
|
+
menu_labels?: GetMenuItemMenuLabelConsumerV3[];
|
|
2936
|
+
}
|
|
2937
|
+
|
|
2938
|
+
export interface GetMenuGroupConsumerV3 {
|
|
2939
|
+
// Menu Group ID
|
|
2940
|
+
id?: string;
|
|
2941
|
+
// Menu Group label
|
|
2942
|
+
label?: GetMenuGroupLabelConsumerV3;
|
|
2943
|
+
// Menu Items
|
|
2944
|
+
items?: GetMenuItemConsumerV3[];
|
|
2945
|
+
}
|
|
2946
|
+
|
|
2947
|
+
export interface GetMenuResponseConsumerV3 {
|
|
2948
|
+
// menu id
|
|
2949
|
+
id: string;
|
|
2950
|
+
// menu label
|
|
2951
|
+
label?: GetMenuLabelConsumerV3;
|
|
2952
|
+
// menu groups
|
|
2953
|
+
groups?: GetMenuGroupConsumerV3[];
|
|
2954
|
+
}
|
|
2955
|
+
|
|
2772
2956
|
export interface GetConsumerMenuItemsResponse {
|
|
2773
2957
|
// meta
|
|
2774
2958
|
meta?: Record<string, any>;
|
|
@@ -4910,6 +5094,15 @@ export interface GetConsumerMenuV2Path {
|
|
|
4910
5094
|
|
|
4911
5095
|
export type GetConsumerMenuV2Response = GetMenuResponseConsumerV2;
|
|
4912
5096
|
|
|
5097
|
+
// GET /consumer/v3/menu/{id} - Get full Menu by ID (v3)
|
|
5098
|
+
|
|
5099
|
+
export interface GetConsumerMenuV3Path {
|
|
5100
|
+
// Menu ID as Encoded CDL ID
|
|
5101
|
+
id: string;
|
|
5102
|
+
}
|
|
5103
|
+
|
|
5104
|
+
export type GetConsumerMenuV3Response = GetMenuResponseConsumerV3;
|
|
5105
|
+
|
|
4913
5106
|
// GET /consumer/menu/{id}/items - Provide the front end with menu items
|
|
4914
5107
|
|
|
4915
5108
|
export interface GetConsumerMenuItemsPath {
|
package/src/interface/menu.ts
CHANGED
|
@@ -557,6 +557,12 @@ export interface DraftBrandDTO {
|
|
|
557
557
|
|
|
558
558
|
export interface BrandMeta {
|
|
559
559
|
jde_category?: string;
|
|
560
|
+
clone?: BrandCloneMeta;
|
|
561
|
+
}
|
|
562
|
+
|
|
563
|
+
export interface BrandCloneMeta {
|
|
564
|
+
source_brand_id?: string;
|
|
565
|
+
status?: string;
|
|
560
566
|
}
|
|
561
567
|
|
|
562
568
|
export interface SupportedLanguages {
|