@compassdigital/sdk.typescript 4.616.0 → 4.618.0

package/lib/interface/consumer.d.ts

@@ -1094,8 +1094,8 @@ export interface HomePageResponse {
 }
 export interface FrictionlessCheckinResponse {
     id: string;
-    provider: Record<string, any>;
-    status: Record<string, any>;
+    provider: 'AWS' | 'SC';
+    status: 'CREATING' | 'ACTIVE' | 'ERROR' | 'CANCELED' | 'PROCESSING' | 'UPDATE_PAYMENT_REQUIRED' | 'COMPLETED';
     reasonOfFail?: string;
     thirdPartyCorrelatedID?: string;
     shoppingCartID?: string;
@@ -1111,7 +1111,24 @@ export interface FrictionlessQrCodeResponse {
     expiration: number;
     id: string;
 }
-export interface ForgotPasswordRequest {
+export interface FrictionlessMealplanPaymentDto {
+    tenderID: string;
+    name: string;
+}
+export interface FrictionlessCreditCardPaymentDto {
+    cardType: string;
+    last4: string;
+}
+export interface FrictionlessPaymentMethodDto {
+    mealplan?: FrictionlessMealplanPaymentDto;
+    creditCard?: FrictionlessCreditCardPaymentDto;
+    token?: string;
+}
+export interface FrictionlessQrCodeV2Request {
+    brandId: string;
+    paymentMethod: FrictionlessPaymentMethodDto;
+}
+export interface ForgotPasswordV1Request {
     email: string;
     captchaResponseKey: string;
     realm?: string;
@@ -1121,9 +1138,11 @@ export interface ForgotPasswordResponse {
     code?: number;
     success?: boolean;
 }
-export interface PostConsumerUserAddSecretBody {
-    key?: string;
+export interface ForgotPasswordRequest {
+    email: string;
+    type?: 'forgot_password' | 'new_user';
 }
+export type PostConsumerUserAddSecretBody = Record<string, any>;
 export interface PostUserAddSecret {
     key?: string;
 }
@@ -1302,7 +1321,14 @@ export interface ConsumerItem {
             primary?: string;
             secondary?: string;
         };
+        jde_category?: string;
     };
+    parent_id?: string;
+    menu_labels?: {
+        id?: string;
+        text?: string;
+        s3_link?: string;
+    }[];
     is_deleted?: boolean;
     is?: {
         disabled?: boolean;
@@ -1338,33 +1364,6 @@ export interface GetMenuItemNutritionValueConsumer {
 export interface GetMenuItemNutritionConsumer {
     calories?: GetMenuItemNutritionValueConsumer;
 }
-export interface Certified {
-    vegan?: boolean;
-    vegetarian?: boolean;
-    seafood_watch?: boolean;
-    wellbeing?: boolean;
-    farm_to_fork?: boolean;
-    in_balance?: boolean;
-    organic?: boolean;
-    no_gluten_ingredients?: boolean;
-    halal?: boolean;
-    kosher?: boolean;
-    humane?: boolean;
-    locally_crafted?: boolean;
-    nuts?: boolean;
-    oracle_garden_grown?: boolean;
-    oracle_oyes?: boolean;
-    peanut_free?: boolean;
-    tree_nut_free?: boolean;
-    wheat_free?: boolean;
-    non_gmo?: boolean;
-    milk_free?: boolean;
-    egg_free?: boolean;
-    soy_free?: boolean;
-    fair_trade?: boolean;
-    rainforest_alliance?: boolean;
-    salt_free?: boolean;
-}
 export interface GetMenuOptionNutritionConsumer {
     calories?: GetMenuItemNutritionValueConsumer;
     total_fat?: GetMenuItemNutritionValueConsumer;
@@ -1386,6 +1385,14 @@ export interface GetMenuItemOptionSizingConsumer {
 export interface GetMenuItemOptionMetaConsumer {
     sizing?: GetMenuItemOptionSizingConsumer[];
 }
+export interface GetMenuItemImageSizesConsumer {
+    original?: string;
+    thumbnail_80_80?: string;
+}
+export interface GetMenuItemImageConsumer {
+    src?: string;
+    sizes?: GetMenuItemImageSizesConsumer;
+}
 export interface GetMenuItemOptionConsumer {
     id?: string;
     label?: GetMenuItemLabelConsumer;
@@ -1416,14 +1423,6 @@ export interface GetMenuItemMetaConsumer {
     barcodes?: string[];
     recipe?: GetMenuItemRecipeConsumer;
 }
-export interface GetMenuItemImageSizesConsumer {
-    original?: string;
-    thumbnail_80_80?: string;
-}
-export interface GetMenuItemImageConsumer {
-    src?: string;
-    sizes?: GetMenuItemImageSizesConsumer;
-}
 export interface GetMenuItemIsConsumer {
     out_of_stock?: boolean;
 }
@@ -1501,10 +1500,9 @@ export interface ConsumerCashlessLog {
     deleted?: string;
 }
 export interface ConsumerUserMeta {
-    is_guest?: boolean;
     marketing_opt_in?: boolean;
     marketing_opt_in_date?: string;
-    marketing_opt_in_source?: Record<string, any>;
+    marketing_opt_in_source?: 'App' | 'Web';
     order_status_notification?: {
         send_emails?: boolean;
         send_emails_date_updated?: string;
@@ -1540,19 +1538,34 @@ export interface ConsumerUserIs {
     deleted?: boolean;
     placeholder?: boolean;
 }
+export interface ConsumerScopes {
+    scopes?: string[];
+}
+export interface ConsumerTemporaryPermissions {
+    expiry: string;
+    scopes: string[];
+}
 export interface PostConsumerUserChangePasswordResponse {
     id: string;
     email: string;
     name?: ConsumerUserName;
     date?: ConsumerUserDate;
-    gender?: Record<string, any>;
+    birthday?: string;
+    password?: string;
+    phone?: number;
+    phone_country_code?: string;
+    realm?: string;
+    location_group?: string;
+    ssoId?: string;
+    last_accessed?: string;
+    gender?: 'male' | 'female' | 'non-binary';
     meta?: ConsumerUserMeta;
     is?: ConsumerUserIs;
-}
-export interface ConsumerScopes {
-    scopes?: string[];
+    permissions?: ConsumerScopes;
+    temporary_permissions?: ConsumerTemporaryPermissions;
 }
 export interface PutConsumerUserRequest {
+    id?: string;
     email?: string;
     name?: ConsumerUserName;
     date?: ConsumerUserDate;
@@ -1561,7 +1574,7 @@ export interface PutConsumerUserRequest {
     phone?: number;
     phone_country_code?: string;
     realm?: string;
-    gender?: Record<string, any>;
+    gender?: 'male' | 'female' | 'non-binary';
     meta?: ConsumerUserMeta;
     is?: ConsumerUserIs;
     permissions?: ConsumerScopes;
@@ -1586,6 +1599,7 @@ export interface PutConsumerUserResponse {
     ssoId?: string;
 }
 export interface PatchConsumerUserRequest {
+    id?: string;
     email?: string;
     name?: ConsumerUserName;
     date?: ConsumerUserDate;
@@ -1594,7 +1608,7 @@ export interface PatchConsumerUserRequest {
     phone?: number;
     phone_country_code?: string;
     realm?: string;
-    gender?: Record<string, any>;
+    gender?: 'male' | 'female' | 'non-binary';
     meta?: ConsumerUserMeta;
     is?: ConsumerUserIs;
     permissions?: ConsumerScopes;
@@ -1628,12 +1642,13 @@ export interface GetConsumerUserResponse {
     phone?: number;
     phone_country_code?: string;
     realm?: string;
-    gender?: Record<string, any>;
+    gender?: 'male' | 'female' | 'non-binary';
     meta?: ConsumerUserMeta;
     is?: ConsumerUserIs;
     permissions?: ConsumerScopes;
     location_group?: string;
     ssoId?: string;
+    last_accessed?: string;
 }
 export interface ConsumerCashlessTender {
     balance?: number;
@@ -2427,18 +2442,33 @@ export interface PostConsumerUserGuestRequest {
     email: string;
     name: ConsumerUserName;
 }
+export interface GuestUserAccess {
+    token?: string;
+    expires?: string;
+}
+export interface GuestUserProfile {
+    id?: string;
+    email?: string;
+    name?: ConsumerUserName;
+    date?: ConsumerUserDate;
+    birthday?: string;
+    password?: string;
+    phone?: number;
+    phone_country_code?: string;
+    realm?: string;
+    gender?: 'male' | 'female' | 'non-binary';
+    meta?: ConsumerUserMeta;
+    is?: ConsumerUserIs;
+    permissions?: ConsumerScopes;
+    location_group?: string;
+    ssoId?: string;
+    last_accessed?: string;
+}
 export interface PostConsumerUserGuestResponse {
     token?: string;
-    access?: {
-        token?: string;
-        expires?: string;
-    };
+    access?: GuestUserAccess;
     user?: string;
-    profile?: {
-        id?: string;
-        email?: string;
-        realm?: string;
-    };
+    profile?: GuestUserProfile;
 }
 export interface OpenAiToolCallFunction {
     name: string;
@@ -2574,6 +2604,311 @@ export interface GetConsumerLocationResponse {
     locations?: ConsumerLocation[];
     address?: ConsumerAddress;
 }
+export interface GetMenuItemNutritionValueConsumerV2 {
+    amount?: number;
+    unit?: string;
+    display?: string;
+}
+export interface GetMenuItemNutritionConsumerV2 {
+    kcal?: number;
+    calories?: GetMenuItemNutritionValueConsumerV2;
+    serving_size?: GetMenuItemNutritionValueConsumerV2;
+    total_fat?: GetMenuItemNutritionValueConsumerV2;
+    saturated_fat?: GetMenuItemNutritionValueConsumerV2;
+    trans_fat?: GetMenuItemNutritionValueConsumerV2;
+    cholesterol?: GetMenuItemNutritionValueConsumerV2;
+    sodium?: GetMenuItemNutritionValueConsumerV2;
+    total_carbohydrate?: GetMenuItemNutritionValueConsumerV2;
+    dietary_fiber?: GetMenuItemNutritionValueConsumerV2;
+    sugars?: GetMenuItemNutritionValueConsumerV2;
+    total_sugars?: GetMenuItemNutritionValueConsumerV2;
+    protein?: GetMenuItemNutritionValueConsumerV2;
+    well_being?: GetMenuItemNutritionValueConsumerV2;
+}
+export interface GetMenuOptionNutritionConsumerV2 {
+    calories?: GetMenuItemNutritionValueConsumerV2;
+    total_fat?: GetMenuItemNutritionValueConsumerV2;
+    saturated_fat?: GetMenuItemNutritionValueConsumerV2;
+    total_carbohydrate?: GetMenuItemNutritionValueConsumerV2;
+    total_sugars?: GetMenuItemNutritionValueConsumerV2;
+    protein?: GetMenuItemNutritionValueConsumerV2;
+    dietary_fiber?: GetMenuItemNutritionValueConsumerV2;
+    sodium?: GetMenuItemNutritionValueConsumerV2;
+    trans_fat?: GetMenuItemNutritionValueConsumerV2;
+    cholesterol?: GetMenuItemNutritionValueConsumerV2;
+    added_sugars?: GetMenuItemNutritionValueConsumerV2;
+}
+export interface GetMenuItemPriceConsumerV2 {
+    amount?: number;
+    currency?: string;
+    total_price?: number;
+    discount?: number;
+}
+export interface GetMenuItemImageSizesConsumerV2 {
+    original?: string;
+    thumbnail_80_80?: string;
+}
+export interface GetMenuItemImageConsumerV2 {
+    src?: string;
+    sizes?: GetMenuItemImageSizesConsumerV2;
+}
+export interface GetMenuItemCertifiedConsumerV2 {
+    vegan?: boolean;
+    vegetarian?: boolean;
+    seafood_watch?: boolean;
+    wellbeing?: boolean;
+    farm_to_fork?: boolean;
+    in_balance?: boolean;
+    organic?: boolean;
+    no_gluten_ingredients?: boolean;
+    halal?: boolean;
+    kosher?: boolean;
+    humane?: boolean;
+    locally_crafted?: boolean;
+    nuts?: boolean;
+    oracle_garden_grown?: boolean;
+    oracle_oyes?: boolean;
+    peanut_free?: boolean;
+    tree_nut_free?: boolean;
+    wheat_free?: boolean;
+    non_gmo?: boolean;
+    milk_free?: boolean;
+    egg_free?: boolean;
+    soy_free?: boolean;
+    fair_trade?: boolean;
+    rainforest_alliance?: boolean;
+    salt_free?: boolean;
+}
+export interface GetMenuItemReportingConsumerV2 {
+    category?: {
+        primary?: string;
+        secondary?: string;
+    };
+    jde_category?: string;
+}
+export interface GetMenuItemIsConsumerV2 {
+    disabled?: boolean;
+    hidden?: boolean;
+    meq_eligible?: boolean;
+    out_of_stock?: boolean;
+    deleted?: boolean;
+    featured?: boolean;
+}
+export interface GetMenuItemMenuLabelConsumerV2 {
+    id?: string;
+    text?: string;
+    s3_link?: string;
+}
+export interface GetMenuItemOptionMetaConsumerV2 {
+    sizing?: {
+        name?: string;
+        posid?: string;
+        price?: number;
+    }[];
+    sort_number?: number;
+    menu_sort_number?: number;
+    unique_id?: number;
+    tax?: {
+        tax_tag_code?: string;
+    };
+}
+export interface GetMenuItemOptionIsConsumerV2 {
+    disabled?: boolean;
+    hidden?: boolean;
+    out_of_stock?: boolean;
+}
+export interface GetMenuItemOptionConsumerV2 {
+    id?: string;
+    label?: {
+        en?: string;
+    };
+    name?: string;
+    description?: {
+        en?: string;
+    };
+    price?: GetMenuItemPriceConsumerV2;
+    nutrition?: GetMenuOptionNutritionConsumerV2;
+    meta?: GetMenuItemOptionMetaConsumerV2;
+    image?: GetMenuItemImageConsumerV2;
+    certified?: GetMenuItemCertifiedConsumerV2;
+    is?: GetMenuItemOptionIsConsumerV2;
+    reporting?: GetMenuItemReportingConsumerV2;
+    sku?: number;
+    weight?: {
+        unit?: string;
+        amount?: number;
+    };
+    line_route?: string;
+    amount_off_exclusions?: string[];
+}
+export interface GetMenuItemGroupIsConsumerV2 {
+    incremental?: boolean;
+}
+export interface GetMenuItemGroupMetaConsumerV2 {
+    order_type?: 'selection' | 'option' | 'quantity';
+    sort_number?: number;
+    menu_sort_number?: number;
+    surcharge_limit_value?: number;
+}
+export interface GetMenuItemOptionsGroupConsumerV2 {
+    id?: string;
+    label?: {
+        en?: string;
+    };
+    items?: GetMenuItemOptionConsumerV2[];
+    min?: number;
+    max?: number;
+    is?: GetMenuItemGroupIsConsumerV2;
+    meta?: GetMenuItemGroupMetaConsumerV2;
+}
+export interface GetMenuItemRecipeConsumerV2 {
+    smart_tags?: string[];
+    allergen_tags?: string[];
+    mrn?: string;
+    unit_id?: string;
+    portion_quantity?: number;
+    portion_unit_name?: string;
+    grams?: number;
+    cost?: number;
+    ingredients?: string[];
+}
+export interface GetMenuItemMetaConsumerV2 {
+    barcodes?: string[];
+    recipe?: GetMenuItemRecipeConsumerV2;
+    superplate?: {
+        type_id?: number;
+        type?: string;
+    };
+    sort_number?: number;
+    menu_sort_number?: number;
+    unique_id?: number;
+    tax?: {
+        tax_tag_code?: string;
+        tax_jwo_code?: string;
+        tax_rate?: number;
+        tax_amount?: number;
+    };
+}
+export interface GetMenuItemConsumerV2 {
+    id?: string;
+    label?: {
+        en?: string;
+    };
+    name?: string;
+    description?: {
+        en?: string;
+    };
+    price?: GetMenuItemPriceConsumerV2;
+    meal_value?: number;
+    sale_price?: GetMenuItemPriceConsumerV2;
+    unit?: number;
+    sku?: number;
+    item_number?: number;
+    parent_id?: string;
+    location?: string;
+    line_route?: string;
+    weight?: {
+        unit?: string;
+        amount?: number;
+    };
+    category?: {
+        en?: string;
+    };
+    ingredients?: Record<string, any>[];
+    amount_off_exclusions?: string[];
+    nutrition?: GetMenuItemNutritionConsumerV2;
+    certified?: GetMenuItemCertifiedConsumerV2;
+    options?: GetMenuItemOptionsGroupConsumerV2[];
+    meta?: GetMenuItemMetaConsumerV2;
+    image?: GetMenuItemImageConsumerV2;
+    is?: GetMenuItemIsConsumerV2;
+    menu_labels?: GetMenuItemMenuLabelConsumerV2[];
+    reporting?: GetMenuItemReportingConsumerV2;
+}
+export interface GetMenuGroupConsumerV2 {
+    id: string;
+    label?: {
+        en?: string;
+        fr?: string;
+    };
+    items?: GetMenuItemConsumerV2[];
+}
+export interface GetMenuIsConsumerV2 {
+    disabled?: boolean;
+    hidden?: boolean;
+    linked?: boolean;
+    promo_exemptions_enabled?: boolean;
+    plu_enabled?: boolean;
+    item_images_enabled?: boolean;
+    item_showcase_enabled?: boolean;
+    item_desc_edit_enabled?: boolean;
+    calories_edit_enabled?: boolean;
+    item_label_edit_enabled?: boolean;
+    frictionless?: boolean;
+    category_images_enabled?: boolean;
+}
+export interface GetMenuMetaConsumerV2 {
+    locked_by_user?: string;
+    last_modified_user?: string;
+    centricos?: boolean;
+    version?: number;
+    revision?: string;
+}
+export interface GetMenuDateConsumerV2 {
+    created?: string;
+    modified?: string;
+    published?: string;
+}
+export interface GetMenuImageSizesConsumerV2 {
+    original?: string;
+    thumbnail_80_80?: string;
+}
+export interface GetMenuImageConsumerV2 {
+    src?: string;
+    sizes?: GetMenuImageSizesConsumerV2;
+}
+export interface GetMenuResponseConsumerV2 {
+    id: string;
+    label?: {
+        en?: string;
+    };
+    groups?: GetMenuGroupConsumerV2[];
+    parent_id?: string;
+    location_brand?: string;
+    company?: string;
+    sector?: string;
+    date?: GetMenuDateConsumerV2;
+    is?: GetMenuIsConsumerV2;
+    meta?: GetMenuMetaConsumerV2;
+    image?: GetMenuImageConsumerV2;
+}
+export interface Certified {
+    vegan?: boolean;
+    vegetarian?: boolean;
+    seafood_watch?: boolean;
+    wellbeing?: boolean;
+    farm_to_fork?: boolean;
+    in_balance?: boolean;
+    organic?: boolean;
+    no_gluten_ingredients?: boolean;
+    halal?: boolean;
+    kosher?: boolean;
+    humane?: boolean;
+    locally_crafted?: boolean;
+    nuts?: boolean;
+    oracle_garden_grown?: boolean;
+    oracle_oyes?: boolean;
+    peanut_free?: boolean;
+    tree_nut_free?: boolean;
+    wheat_free?: boolean;
+    non_gmo?: boolean;
+    milk_free?: boolean;
+    egg_free?: boolean;
+    soy_free?: boolean;
+    fair_trade?: boolean;
+    rainforest_alliance?: boolean;
+    salt_free?: boolean;
+}
 export type HealthCheckControllerExecuteResponse = {};
 export interface GetPaymentListByBrandQuery {
     brandID?: string;
@@ -2617,8 +2952,17 @@ export interface GetConsumerFrictionlessCheckinPath {
 export type GetConsumerFrictionlessCheckinResponse = FrictionlessCheckinResponse;
 export type PostFrictionlessQrcodeBody = FrictionlessQrCodeRequest;
 export type PostFrictionlessQrcodeResponse = FrictionlessQrCodeResponse;
-export type PostConsumerForgotPasswordBody = ForgotPasswordRequest;
+export type PostConsumerV2FrictionlessQrcodeBody = FrictionlessQrCodeV2Request;
+export type PostConsumerV2FrictionlessQrcodeResponse = FrictionlessQrCodeResponse;
+export type PostConsumerForgotPasswordBody = ForgotPasswordV1Request;
 export type PostConsumerForgotPasswordResponse = ForgotPasswordResponse;
+export interface PostConsumerV2ForgotPasswordQuery {
+    captchaResponseKey: string;
+    realm?: string;
+    lang?: string;
+}
+export type PostConsumerV2ForgotPasswordBody = ForgotPasswordRequest;
+export type PostConsumerV2ForgotPasswordResponse = ForgotPasswordResponse;
 export interface PostConsumerAddSecretPath {
     id: string;
     key: string;
@@ -2946,4 +3290,8 @@ export interface GetConsumerLocationQuery {
     active_cafes?: string[];
 }
 export type GetConsumerLocationResponse$0 = GetConsumerLocationResponse;
+export interface GetConsumerMenuV2Path {
+    id: string;
+}
+export type GetConsumerMenuV2Response = GetMenuResponseConsumerV2;
 //# sourceMappingURL=consumer.d.ts.map