@compassdigital/sdk.typescript 4.319.0 → 4.321.0

package/lib/interface/partner.d.ts

@@ -4,918 +4,6 @@ export interface Error {
     code?: number;
     data?: Record<string, any>;
 }
-export interface ShoppingCartResponse {
-    id?: string;
-    location?: string;
-    menu?: string;
-    brand?: string;
-    date?: Record<string, any>;
-    items?: ItemResponse[];
-    sub_total?: {
-        amount?: MonetaryValue;
-    };
-    promo?: {
-        code?: string;
-        provider?: 'fp' | 'voucherify';
-        amount_off?: MonetaryValue;
-        percent_off?: MonetaryValue;
-        amount?: MonetaryValue;
-        app?: string;
-        discount?: Record<string, any>;
-        provider_data?: FPValidationData;
-        order?: {
-            items_applied_discount_amount?: number;
-            amount?: number;
-            items_discount_amount?: number;
-            total_amount?: number;
-            total_applied_discount_amount?: number;
-            total_discount_amount?: number;
-            items?: {
-                applied_discount_amount?: number;
-                amount?: number;
-                discount_amount?: number;
-                price?: number;
-                quantity?: number;
-                source_id?: string;
-                subtotal_amount?: number;
-            }[];
-        };
-    };
-    loyalty?: {
-        coupon?: {
-            code?: string;
-            amount_off?: MonetaryValue;
-            amount?: MonetaryValue;
-            name?: string;
-        };
-        order_loyalty_points?: boolean;
-    };
-    discount?: ShoppingCartResponse['promo'];
-    discounts?: {
-        id: string;
-        createdAt: string;
-        updatedAt: string;
-        createdBy: string;
-        updatedBy: string;
-        name: string;
-        is?: {
-            badgepayPromo?: boolean;
-            mealplanPromo?: boolean;
-            decliningBalancePromo?: boolean;
-            voucherPromo?: boolean;
-        };
-        status?: {
-            live?: boolean;
-            publishedTo3rdParty?: boolean;
-            readyToPublish?: boolean;
-        };
-        meta?: {
-            provider: {
-                voucherify?: {
-                    id?: string;
-                    code?: string;
-                    discount?: {
-                        type: string;
-                        amountOff?: number;
-                        percentOff?: number;
-                    };
-                };
-            };
-        };
-    }[];
-    payment_method?: {
-        mealplan?: {
-            id?: string;
-            tender?: string;
-            total?: MonetaryValue;
-            type?: PaymentType;
-        };
-        credit_card?: {
-            card_type?: string;
-            last4?: string;
-            total?: MonetaryValue;
-            type?: PaymentType;
-        };
-        digital_wallet_pay?: {
-            wallet_type?: string;
-            total?: MonetaryValue;
-            type?: PaymentType;
-        };
-        meal_swipes?: {
-            id?: string;
-            tender?: string;
-            tender_type?: string;
-            tender_name?: string;
-            swipes?: MonetaryValue;
-            rate?: MonetaryValue;
-            total?: MonetaryValue;
-            type?: PaymentType;
-        };
-        meal_exchange?: {
-            id?: string;
-            tender?: string;
-            type?: PaymentType;
-        };
-        badge_pay?: CashlessTender;
-        stipend?: CashlessTender;
-        voucher?: CashlessTender;
-        coupon_voucher?: CashlessTender;
-    };
-    taxes?: Taxes;
-    total?: {
-        amount?: MonetaryValue;
-        meals?: MonetaryValue;
-    };
-    exemptions?: {
-        tax?: boolean;
-    };
-    order?: {
-        id?: string;
-    };
-    service_fee?: {
-        amount?: MonetaryValue;
-    };
-    delivery_fee?: {
-        amount?: MonetaryValue;
-    };
-    is?: {
-        type?: 'delivery' | 'pickup' | 'scan_and_go' | 'frictionless';
-        mx_cart?: boolean;
-        email_tax_exempt?: boolean;
-        tax_calculation_required?: boolean;
-        system365?: boolean;
-    };
-    meta?: {
-        vendor?: Record<string, any>;
-        drain_order_type?: {
-            taxable?: boolean;
-            tax_exempt?: boolean;
-        };
-        [index: string]: any;
-    };
-}
-export interface ItemResponse {
-    id: string;
-    description?: Label;
-    _index?: string;
-    quantity: Quantity;
-    quantity_by_weight?: {
-        unit?: string;
-        value?: number;
-    };
-    unit?: number;
-    price?: Price;
-    sale_price?: {
-        active?: boolean;
-        amount?: MonetaryValue;
-    };
-    weighed_price?: Price;
-    _subtotal?: {
-        amount?: MonetaryValue;
-    };
-    _promo?: {
-        amount?: MonetaryValue;
-    };
-    _discount?: {
-        amount?: MonetaryValue;
-    };
-    meta?: {
-        menu?: string;
-        brand?: string;
-        brand_label?: Label;
-        taxes?: string[];
-        tax?: {
-            tax_tag_code?: string;
-            tax_rate?: number;
-            tax_amount?: number;
-        };
-        menu_tax_tags?: string[];
-        orderable?: boolean;
-        volante_id?: string;
-        barcodes?: string[];
-        plu?: string;
-        [index: string]: any;
-    };
-    options?: {
-        id?: string;
-        label?: Label;
-        meta?: {
-            taxes?: string[];
-            original_label?: Label;
-            order_type?: 'selection' | 'option' | 'quantity';
-            surchage_limit_value?: number;
-        };
-        items?: {
-            id?: string;
-            price?: Price;
-            quantity?: Quantity;
-            label?: Label;
-            _index?: string;
-            meta?: {
-                sort_number?: number;
-                original_label?: Label;
-                taxes?: string[];
-                sizing?: {
-                    name?: string;
-                    price?: MonetaryValue;
-                    posid?: string;
-                }[];
-            };
-            amount_off_exclusions?: AmountOffExclusion[];
-            is?: {
-                disabled?: boolean;
-            };
-        }[];
-        is?: {
-            disabled?: boolean;
-            incremental?: boolean;
-            surchage_limit?: boolean;
-        };
-    }[];
-    item_discount?: Record<string, any>;
-    special_instructions?: string;
-    amount_off_exclusions?: AmountOffExclusion[];
-    added_on?: string;
-    meal_value?: IntegerValue;
-    category?: Label;
-    menu_label?: Label;
-    tax_rate?: MonetaryValue;
-    label?: Label;
-    reporting?: {
-        category?: {
-            primary?: string;
-            secondary?: string;
-        };
-    };
-}
-export type MonetaryValue = number;
-export type PaymentType = string;
-export interface FPValidationData {
-    discountIncentives?: {
-        id?: string;
-        program?: {
-            code?: string;
-        };
-        [index: string]: any;
-    }[];
-    [index: string]: any;
-}
-export type AmountOffExclusion = 'discount' | 'promo';
-export interface Label {
-    en?: string;
-    fr?: string;
-}
-export type IntegerValue = number;
-export interface Price {
-    amount?: MonetaryValue;
-}
-export type Quantity = number;
-export interface CashlessTender {
-    id?: string;
-    total?: MonetaryValue;
-    tender?: string;
-    name?: string;
-    type?: PaymentType;
-}
-export interface Taxes {
-    amount?: MonetaryValue;
-    rate?: MonetaryValue;
-    breakdown?: {
-        taxable_amount?: MonetaryValue;
-        tax_collectable?: MonetaryValue;
-        combined_tax_rate?: MonetaryValue;
-        gst?: MonetaryValue;
-        pst?: MonetaryValue;
-        provider?: string;
-        [index: string]: any;
-    };
-    provider?: string;
-    quote_payload?: {
-        id: string;
-        appName: string;
-        transactionType: 'pickup' | 'delivery';
-        serviceFee?: number;
-        deliveryFee?: number;
-        locationData: {
-            id: string;
-            country: string;
-            stateOrProvince: string;
-            city: string;
-            postalCode: string;
-            streetAddress: string;
-        };
-        items: {
-            id: string;
-            taxTagCode: string;
-            quantity: number;
-            price: number;
-            taxedAmount?: number;
-        }[];
-        transactionDate?: string;
-        refunds?: {
-            refundItemId: string;
-            refundItemQuantity: number;
-        }[];
-    };
-}
-export interface LocationGroup {
-    id?: string;
-    name?: string;
-    label?: {
-        en?: string;
-        fr?: string;
-    };
-    distance?: number;
-    locations?: Location[];
-    address?: Address;
-    meta?: Record<string, any>;
-    style?: {
-        logo?: string | null;
-        main_logo?: string | null;
-        alt_logo?: string | null;
-    };
-    timezone?: string;
-    device_mapping?: Record<string, {
-        device_type?: string;
-        site_device_id?: string;
-        name?: string;
-    }[]>;
-    [index: string]: any;
-}
-export interface Location {
-    id?: string;
-    operation_id?: number;
-    name?: string;
-    label?: {
-        en?: string;
-        fr?: string;
-    };
-    search?: string[];
-    app?: string;
-    address?: Address;
-    latitude?: number;
-    longitude?: number;
-    brands?: Brand[];
-    meta?: Record<string, any>;
-    phone?: string;
-    location_group?: string;
-    location_multigroup?: string;
-    sector?: string;
-    date?: {
-        deleted?: string;
-        created?: string;
-        modified?: string;
-    };
-    market_place?: {
-        label?: {
-            en?: string;
-            fr?: string;
-        };
-        location_description?: {
-            en?: string;
-            fr?: string;
-        };
-        logo?: string;
-        is?: {
-            enabled?: boolean;
-            pickup_supported?: boolean;
-            delivery_supported?: boolean;
-        };
-        delivery_details?: {
-            show_single_timeslot?: boolean;
-            show_instructions?: boolean;
-            runner_app_enabled?: boolean;
-        };
-        delivery_destinations?: string[];
-        pickup_instruction?: {
-            en?: string;
-            fr?: string;
-        };
-        hours?: Hours[];
-        deliveryHours?: DeliveryHours[];
-        service_fee?: {
-            type?: string;
-            value?: number;
-        };
-        [index: string]: any;
-    };
-    [index: string]: any;
-}
-export interface Brand {
-    id?: string;
-    sector?: string;
-    name?: string;
-    label?: {
-        en?: string;
-        fr?: string;
-    };
-    timezone?: string;
-    description?: string;
-    latitude?: number;
-    longitude?: number;
-    address?: Address;
-    menus?: MenuHours[];
-    date?: {
-        deleted?: string;
-        created?: string;
-    };
-    hours?: Hours[];
-    deliveryHours?: DeliveryHours[];
-    style?: {
-        logo?: string | null;
-        main_logo?: string | null;
-        alt_logo?: string | null;
-    };
-    pos?: string;
-    terminals?: Record<string, any>[];
-    device_mapping?: Record<string, {
-        device_type: string;
-        site_device_id: string;
-        business_units?: string[];
-    }[]>;
-    timeslots?: {
-        time?: string;
-        averagePrepTime?: string;
-        duration_minutes?: number;
-        customers_per_slot?: number;
-        menu_items_per_slot?: number;
-        delivery_time?: string;
-        delivery_customers_per_slot?: number;
-        delivery_menu_items_per_slot?: number;
-        delivery_prep_time?: string;
-        delivery_is_user_defined?: boolean;
-        delivery_user_defined?: {
-            start_time: string;
-            end_time: string;
-            delivery_destinations?: string[];
-        }[];
-    };
-    is?: {
-        pickup_supported?: boolean;
-        delivery_supported?: boolean;
-        frictionless_supported?: boolean;
-        plu_enabled?: boolean;
-        promo_exemptions_enabled?: boolean;
-        local_images_enabled?: boolean;
-        hidden?: boolean;
-        show_in_kiosk?: boolean;
-        show_in_pos?: boolean;
-        item_desc_edit_enabled?: boolean;
-        scan_and_go_supported?: boolean;
-        calories_edit_enabled?: boolean;
-        special_instructions_enabled?: boolean;
-        dining_hall?: boolean;
-        [index: string]: any;
-    };
-    brand?: string;
-    location?: string;
-    group?: string;
-    payment_provider?: string;
-    location_description?: string;
-    company?: string;
-    config?: {
-        private?: Record<string, any>;
-        public?: Record<string, any>;
-    };
-    tax_rate?: number;
-    meta?: {
-        scout?: {
-            user_id?: string;
-            name?: {
-                first?: string;
-                last?: string;
-            };
-        };
-        partner?: {
-            user_id?: string;
-            name?: {
-                first?: string;
-                last?: string;
-            };
-        };
-        contact?: {
-            name?: string;
-            role?: string;
-            email?: string;
-            phone?: string;
-        };
-        market_id?: string;
-        partner_type?: string;
-        business_number?: number;
-        website?: string;
-        cuisine_types?: string[];
-        status?: 'await_partner' | 'await_scout' | 'completed';
-        active?: boolean;
-        max_showcase_items?: number;
-        jde_category?: string;
-        software_integrations?: {
-            system365?: string;
-            jwo?: string;
-            time2eat?: {
-                enabled?: boolean;
-                use_timeslots?: boolean;
-                ignore_station_hours?: boolean;
-            };
-            nextep?: {
-                mobile_app?: boolean;
-                web?: boolean;
-            };
-            mashgin?: {
-                enabled?: boolean;
-            };
-        };
-        type_of_kds?: {
-            cdl?: boolean;
-            nextep?: boolean;
-            volante?: boolean;
-            agilysys?: boolean;
-            [index: string]: any;
-        };
-        [index: string]: any;
-    };
-    descriptions?: {
-        location?: {
-            en?: string;
-            fr?: string;
-        };
-    };
-    estimated_wait_time?: {
-        delivery?: WaitTime;
-        pickup?: WaitTime;
-    };
-    state?: {
-        pickup?: MenuHours['state'];
-        delivery?: MenuHours['state'];
-    };
-    [index: string]: any;
-}
-export interface Address {
-    suite?: string;
-    address?: string;
-    city?: string;
-    state?: string;
-    country?: string;
-    zip?: string;
-    coordinates?: {
-        latitude?: number;
-        longitude?: number;
-    };
-}
-export interface MenuHours {
-    id?: string;
-    label?: {
-        en?: string;
-    };
-    hours?: Hours[];
-    is_pickup?: boolean;
-    is_delivery?: boolean;
-    is_frictionless?: boolean;
-    state?: 'open' | 'closed' | 'preorder';
-    is_disabled?: boolean;
-}
-export interface Hours {
-    id?: string;
-    date?: {
-        deleted?: string;
-        start?: string;
-        end?: string;
-    };
-    day?: {
-        start?: number;
-        end?: number;
-    };
-    hours?: string;
-}
-export interface DeliveryHours {
-    id?: string;
-    day?: {
-        start?: number;
-        end?: number;
-    };
-    hours?: string;
-}
-export interface WaitTime {
-    max: number;
-    min: number;
-    ready_time: number;
-}
-export interface Menu {
-    id?: string;
-    date?: {
-        created?: string;
-        modified?: string;
-        published?: string;
-    };
-    label?: {
-        en?: string;
-    };
-    groups?: Group[];
-    parent_id?: string;
-    location_brand?: string;
-    company?: string;
-    sector?: string;
-    is?: {
-        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;
-    };
-    meta?: {
-        locked_by_user?: string;
-        last_modified_user?: string;
-        centricos?: boolean;
-        version?: number;
-        brand?: {
-            id?: string;
-            name?: string;
-        };
-        local_menu_group?: {
-            id?: string;
-            name?: string;
-        };
-        [index: string]: any;
-    };
-}
-export interface Group {
-    id?: string;
-    name?: string;
-    label?: {
-        en?: string;
-        fr?: string;
-    };
-    items?: {
-        id?: string;
-        label?: {
-            en?: string;
-        };
-        name?: string;
-        description?: {
-            en?: string;
-        };
-        price?: {
-            amount?: number;
-            currency?: string;
-            total_price?: number;
-            discount?: number;
-        };
-        meal_value?: number;
-        sale_price?: {
-            amount?: number;
-            currency?: string;
-        };
-        unit?: number;
-        ingredients?: Record<string, any>[];
-        amount_off_exclusions?: AmountOffExclusionTypes[];
-        nutrition?: {
-            kcal?: number;
-            calories?: Nutrition;
-            serving_size?: Nutrition;
-            total_fat?: Nutrition;
-            saturated_fat?: Nutrition;
-            trans_fat?: Nutrition;
-            cholesterol?: Nutrition;
-            sodium?: Nutrition;
-            total_carbohydrate?: Nutrition;
-            dietary_fiber?: Nutrition;
-            sugars?: Nutrition;
-            protein?: Nutrition;
-            well_being?: Nutrition;
-            [index: string]: any;
-        };
-        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;
-        };
-        options?: {
-            id?: string;
-            label?: {
-                en?: string;
-            };
-            unique_name?: string;
-            name?: string;
-            items?: {
-                id?: string;
-                label?: {
-                    en?: string;
-                };
-                name?: string;
-                description?: {
-                    en?: string;
-                };
-                price?: {
-                    amount?: number;
-                    currency?: string;
-                };
-                reporting?: {
-                    category?: {
-                        primary?: string;
-                        secondary?: string;
-                    };
-                };
-                weight?: {
-                    unit?: string;
-                    amount?: number;
-                };
-                image?: {
-                    src?: string;
-                    sizes?: {
-                        original?: string;
-                        thumbnail_80_80?: string;
-                    };
-                };
-                sku?: number;
-                nutrition?: {
-                    kcal?: number;
-                    calories?: Nutrition;
-                };
-                certified?: {
-                    vegan?: boolean;
-                };
-                modifier_sets?: {
-                    category?: string;
-                    list?: string[];
-                }[];
-                meta?: {
-                    sort_number?: number;
-                    menu_sort_number?: number;
-                    sizing?: {
-                        name?: string;
-                        posid?: string;
-                        price?: number;
-                    }[];
-                    tax?: {
-                        tax_tag_code?: string;
-                    };
-                    recipe?: {
-                        mrn?: string;
-                        unit_id?: string;
-                        portion_quantity?: number;
-                        portion_unit_name?: string;
-                        grams?: number;
-                        cost?: number;
-                        ingredients?: string[];
-                        smart_tags?: string[];
-                        allergen_tags?: string[];
-                    };
-                    unique_id?: number;
-                    [index: string]: any;
-                };
-                is?: {
-                    disabled?: boolean;
-                    hidden?: boolean;
-                    out_of_stock?: boolean;
-                };
-                amount_off_exclusions?: AmountOffExclusionTypes[];
-                line_route?: string;
-            }[];
-            min?: number;
-            max?: number;
-            is?: {
-                disabled?: boolean;
-                hidden?: boolean;
-                out_of_stock?: boolean;
-                incremental?: boolean;
-                surcharge_limit?: boolean;
-            };
-            meta?: {
-                sort_number?: number;
-                order_type?: 'selection' | 'option' | 'quantity';
-                surcharge_limit_value?: number;
-                menu_sort_number?: number;
-                [index: string]: any;
-            };
-            limit?: number;
-            [index: string]: any;
-        }[];
-        required?: boolean;
-        special?: boolean;
-        meta?: {
-            superplate?: {
-                type_id?: number;
-                type?: string;
-            };
-            sort_number?: number;
-            menu_sort_number?: number;
-            barcodes?: string[];
-            tax?: {
-                tax_tag_code?: string;
-                tax_jwo_code?: string;
-                tax_rate?: number;
-                tax_amount?: number;
-            };
-            recipe?: {
-                mrn?: string;
-                unit_id?: string;
-                portion_quantity?: number;
-                portion_unit_name?: string;
-                grams?: number;
-                cost?: number;
-                ingredients?: string[];
-                smart_tags?: string[];
-                allergen_tags?: string[];
-            };
-            unique_id?: number;
-        };
-        category?: {
-            en?: string;
-        };
-        location?: string;
-        sku?: number;
-        item_number?: number;
-        image?: {
-            src?: string;
-            sizes?: {
-                original?: string;
-                thumbnail_80_80?: string;
-            };
-        };
-        weight?: {
-            unit?: string;
-            amount?: number;
-        };
-        line_route?: string;
-        reporting?: {
-            category?: {
-                primary?: string;
-                secondary?: string;
-            };
-        };
-        is_deleted?: boolean;
-        is?: {
-            disabled?: boolean;
-            hidden?: boolean;
-            meq_eligible?: boolean;
-            out_of_stock?: boolean;
-            deleted?: boolean;
-            featured?: boolean;
-        };
-    }[];
-    is_disabled?: boolean;
-    is?: {
-        disabled?: boolean;
-        hidden?: boolean;
-        item_images_enabled?: boolean;
-    };
-    meta?: {
-        sort_number?: number;
-        menu_sort_number?: number;
-        [index: string]: any;
-    };
-    image?: {
-        src?: string;
-        sizes?: {
-            original?: string;
-            thumbnail_80_80?: string;
-        };
-    };
-}
-export interface Nutrition {
-    amount?: number;
-    unit?: string;
-}
-export type AmountOffExclusionTypes = 'loyalty' | 'discount' | 'promo';
-export interface CognitionStore {
-    uuid?: string;
-    name?: string;
-    address?: string;
-    city?: string;
-    state?: string;
-    street_address?: string;
-    currency_code?: string;
-    latitude?: number;
-    longitude?: number;
-}
 export interface Success {
     success?: boolean;
 }