@compassdigital/sdk.typescript 3.39.0 → 3.40.0

package/lib/interface/partner.d.ts

@@ -9,52 +9,7 @@ export interface ShoppingCart {
     menu?: string;
     brand?: string;
     date?: any;
-    items?: {
-        id: string;
-        _index?: string;
-        quantity: number;
-        unit?: number;
-        price?: {
-            amount?: number;
-        };
-        sale_price?: {
-            active?: boolean;
-            amount?: number;
-        };
-        _subtotal?: {
-            amount?: number;
-        };
-        _promo?: {
-            amount?: number;
-        };
-        meta?: {
-            menu?: string;
-            brand?: string;
-            [index: string]: any;
-        };
-        options?: {
-            id?: string;
-            label?: {
-                en?: string;
-            };
-            meta?: any;
-            items?: {
-                id?: string;
-                label?: {
-                    en?: string;
-                };
-                _index?: string;
-                meta?: any;
-                quantity?: number;
-                amount_off_exclusions?: string[];
-            }[];
-        }[];
-        item_discount?: any;
-        special_instructions?: string;
-        amount_off_exclusions?: string[];
-        added_on?: string;
-        [index: string]: any;
-    }[];
+    items?: Item[];
     sub_total?: {
         amount?: number;
     };
@@ -65,6 +20,15 @@ export interface ShoppingCart {
         amount?: number;
         app?: string;
     };
+    loyalty?: {
+        coupon?: {
+            code?: string;
+            amount_off?: number;
+            amount?: number;
+            name?: string;
+        };
+        order_loyalty_points?: boolean;
+    };
     discount?: {
         code?: string;
         amount_off?: number;
@@ -100,19 +64,9 @@ export interface ShoppingCart {
             id?: string;
             tender?: string;
         };
+        badge_pay?: BadgePay;
     };
-    taxes?: {
-        amount?: number;
-        rate?: number;
-        breakdown?: {
-            taxable_amount?: number;
-            tax_collectable?: number;
-            combined_tax_rate?: number;
-            gst?: number;
-            pst?: number;
-            [index: string]: any;
-        };
-    };
+    taxes?: taxes;
     total?: {
         amount?: number;
         meals?: number;
@@ -132,15 +86,78 @@ export interface ShoppingCart {
     is?: {
         type?: string;
         mx_cart?: boolean;
-        domain_tax_exempt?: boolean;
+        email_tax_exempt?: boolean;
+        tax_calculation_required?: boolean;
     };
     meta?: {
         vendor?: any;
         [index: string]: any;
     };
 }
-export declare type Item = any;
-export declare type taxes = ShoppingCart["taxes"];
+export interface Item {
+    id: string;
+    _index?: string;
+    quantity: number;
+    unit?: number;
+    price?: {
+        amount?: number;
+    };
+    sale_price?: {
+        active?: boolean;
+        amount?: number;
+    };
+    _subtotal?: {
+        amount?: number;
+    };
+    _promo?: {
+        amount?: number;
+    };
+    meta?: {
+        menu?: string;
+        brand?: string;
+        [index: string]: any;
+    };
+    options?: {
+        id?: string;
+        label?: {
+            en?: string;
+        };
+        meta?: any;
+        items?: {
+            id?: string;
+            label?: {
+                en?: string;
+            };
+            _index?: string;
+            meta?: any;
+            quantity?: number;
+            amount_off_exclusions?: string[];
+        }[];
+    }[];
+    item_discount?: any;
+    special_instructions?: string;
+    amount_off_exclusions?: string[];
+    added_on?: string;
+    [index: string]: any;
+}
+export interface BadgePay {
+    id?: string;
+    total?: number;
+    tender?: string;
+    name?: string;
+}
+export interface taxes {
+    amount?: number;
+    rate?: number;
+    breakdown?: {
+        taxable_amount?: number;
+        tax_collectable?: number;
+        combined_tax_rate?: number;
+        gst?: number;
+        pst?: number;
+        [index: string]: any;
+    };
+}
 export interface LocationGroup {
     id?: string;
     name?: string;
@@ -149,215 +166,230 @@ export interface LocationGroup {
         fr?: string;
     };
     distance?: number;
-    locations?: {
-        id?: string;
-        operation_id?: number;
-        name?: string;
+    locations?: Location[];
+    address?: Address;
+    meta?: {
+        [index: string]: any;
+    };
+    style?: any;
+    [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?: {
+        [index: 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;
         };
-        search?: string[];
-        app?: string;
-        address?: Brand["address"];
-        latitude?: number;
-        longitude?: number;
-        brands?: {
-            id?: string;
-            sector?: string;
-            name?: string;
-            label?: {
-                en?: string;
-                fr?: string;
-            };
-            timezone?: string;
-            description?: string;
-            latitude?: number;
-            longitude?: number;
-            address?: {
-                suite?: string;
-                address?: string;
-                city?: string;
-                state?: string;
-                country?: string;
-                zip?: string;
-                coordinates?: {
-                    latitude?: number;
-                    longitude?: number;
-                };
-            };
-            menus?: {
-                id?: string;
-                label?: {
-                    en?: string;
-                };
-                hours?: any[];
-                is_pickup?: boolean;
-                is_delivery?: boolean;
-                is_frictionless?: boolean;
-            }[];
-            date?: {
-                created?: string;
-            };
-            hours?: {
-                id?: string;
-                date?: {
-                    start?: string;
-                    end?: string;
-                };
-                day?: {
-                    start?: number;
-                    end?: number;
-                };
-                hours?: string;
-            }[];
-            deliveryHours?: {
-                id?: string;
-                day?: {
-                    start?: number;
-                    end?: number;
-                };
-                hours?: string;
-            }[];
-            style?: any;
-            pos?: string;
-            terminals?: any[];
-            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;
-                plu_enabled?: boolean;
-                promo_exemptions_enabled?: boolean;
-                local_images_enabled?: boolean;
-                hidden?: boolean;
-                item_desc_edit_enabled?: boolean;
-                scan_and_go_supported?: boolean;
-                calories_edit_enabled?: boolean;
-                special_instructions?: boolean;
-                [index: string]: any;
-            };
-            brand?: string;
-            location?: string;
-            group?: string;
-            payment_provider?: string;
-            location_description?: string;
-            company?: string;
-            config?: {
-                private?: any;
-                public?: 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?: string;
-                active?: boolean;
-                max_showcase_items?: number;
-                jde_category?: string;
-            };
-            descriptions?: {
-                location?: {
-                    en?: string;
-                    fr?: string;
-                };
-            };
-            [index: string]: any;
-        }[];
-        meta?: any;
-        phone?: string;
-        location_group?: string;
-        location_multigroup?: string;
-        sector?: string;
-        date?: {
-            created?: string;
-            modified?: string;
+        location_description?: {
+            en?: string;
+            fr?: string;
         };
-        market_place?: {
-            label?: {
-                en?: string;
-                fr?: string;
-            };
-            location_description?: {
-                en?: string;
-                fr?: string;
-            };
-            logo?: string;
-            is?: {
-                pickup_supported?: boolean;
-                delivery_supported?: boolean;
-            };
-            delivery_details?: {
-                show_single_timeslot?: boolean;
-                show_instructions?: boolean;
-                runner_app_enabled?: boolean;
-            };
+        logo?: string;
+        is?: {
+            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?: any;
+        deliveryHours?: any;
+        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?: any;
+    pos?: string;
+    terminals?: any[];
+    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[];
-            pickup_instruction?: {
-                en?: string;
-                fr?: string;
+        }[];
+    };
+    is?: {
+        pickup_supported?: boolean;
+        delivery_supported?: boolean;
+        plu_enabled?: boolean;
+        promo_exemptions_enabled?: boolean;
+        local_images_enabled?: boolean;
+        hidden?: boolean;
+        item_desc_edit_enabled?: boolean;
+        scan_and_go_supported?: boolean;
+        calories_edit_enabled?: boolean;
+        special_instructions?: boolean;
+        [index: string]: any;
+    };
+    brand?: string;
+    location?: string;
+    group?: string;
+    payment_provider?: string;
+    location_description?: string;
+    company?: string;
+    config?: {
+        private?: any;
+        public?: any;
+    };
+    tax_rate?: number;
+    meta?: {
+        scout?: {
+            user_id?: string;
+            name?: {
+                first?: string;
+                last?: string;
             };
-            hours?: any;
-            deliveryHours?: any;
-            service_fee?: {
-                type?: string;
-                value?: number;
+        };
+        partner?: {
+            user_id?: string;
+            name?: {
+                first?: string;
+                last?: string;
             };
-            [index: string]: any;
         };
-        [index: string]: any;
-    }[];
-    address?: Brand["address"];
-    meta?: {
+        contact?: {
+            name?: string;
+            role?: string;
+            email?: string;
+            phone?: string;
+        };
+        market_id?: string;
+        partner_type?: string;
+        business_number?: number;
+        website?: string;
+        cuisine_types?: string[];
+        status?: string;
+        active?: boolean;
+        max_showcase_items?: number;
+        jde_category?: string;
         [index: string]: any;
     };
-    style?: any;
+    descriptions?: {
+        location?: {
+            en?: string;
+            fr?: string;
+        };
+    };
+    estimated_wait_time?: {
+        delivery?: WaitTime;
+        pickup?: WaitTime;
+    };
     [index: string]: any;
 }
-export declare type Location = any;
-export declare type Brand = any;
-export declare type Address = Brand["address"];
-export declare type MenuHours = any;
-export declare type Hours = any;
-export declare type DeliveryHours = 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;
+}
+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?: {
@@ -368,202 +400,202 @@ export interface Menu {
     label?: {
         en?: string;
     };
-    groups?: {
+    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;
+    };
+    meta?: {
+        locked_by_user?: string;
+        last_modified_user?: string;
+        [index: string]: any;
+    };
+}
+export interface Group {
+    id?: string;
+    label?: {
+        en?: string;
+        fr?: string;
+    };
+    items?: {
         id?: string;
         label?: {
             en?: string;
-            fr?: string;
         };
-        items?: {
+        description?: {
+            en?: string;
+        };
+        price?: {
+            amount?: number;
+            currency?: string;
+        };
+        meal_value?: number;
+        sale_price?: {
+            amount?: number;
+            currency?: string;
+        };
+        unit?: number;
+        ingredients?: any[];
+        amount_off_exclusions?: string[];
+        nutrition?: {
+            kcal?: number;
+            calories?: any;
+            serving_size?: any;
+            total_fat?: any;
+            saturated_fat?: any;
+            trans_fat?: any;
+            cholesterol?: any;
+            sodium?: {
+                amount?: number;
+                unit?: string;
+            };
+            total_carbohydrate?: any;
+            dietary_fiber?: any;
+            sugars?: any;
+            protein?: any;
+            well_being?: any;
+            [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;
             };
-            description?: {
-                en?: string;
-            };
-            price?: {
-                amount?: number;
-                currency?: string;
-            };
-            meal_value?: number;
-            sale_price?: {
-                amount?: number;
-                currency?: string;
-            };
-            unit?: number;
-            ingredients?: any[];
-            amount_off_exclusions?: string[];
-            nutrition?: {
-                kcal?: number;
-                calories?: any;
-                serving_size?: any;
-                total_fat?: any;
-                saturated_fat?: any;
-                trans_fat?: any;
-                cholesterol?: any;
-                sodium?: {
-                    amount?: number;
-                    unit?: string;
-                };
-                total_carbohydrate?: any;
-                dietary_fiber?: any;
-                sugars?: any;
-                protein?: any;
-                well_being?: any;
-                [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?: {
+            unique_name?: string;
+            items?: {
                 id?: string;
                 label?: {
                     en?: string;
                 };
-                unique_name?: string;
-                items?: {
-                    id?: string;
-                    label?: {
-                        en?: string;
-                    };
-                    price?: {
-                        amount?: number;
-                        currency?: string;
-                    };
-                    sku?: number;
-                    nutrition?: {
-                        kcal?: number;
-                        calories?: any;
-                    };
-                    certified?: {
-                        vegan?: boolean;
-                    };
-                    modifier_sets?: {
-                        category?: string;
-                        list?: string[];
-                    }[];
-                    meta?: {
-                        sort_number?: number;
-                        menu_sort_number?: number;
-                        [index: string]: any;
-                    };
-                    is?: {
-                        disabled?: boolean;
-                        hidden?: boolean;
-                        out_of_stock?: boolean;
-                    };
-                    amount_off_exclusions?: any[];
-                }[];
-                min?: number;
-                max?: number;
-                is?: {
-                    disabled?: boolean;
-                    hidden?: boolean;
-                    out_of_stock?: boolean;
+                price?: {
+                    amount?: number;
+                    currency?: string;
                 };
+                sku?: number;
+                nutrition?: {
+                    kcal?: number;
+                    calories?: any;
+                };
+                certified?: {
+                    vegan?: boolean;
+                };
+                modifier_sets?: {
+                    category?: string;
+                    list?: string[];
+                }[];
                 meta?: {
                     sort_number?: number;
                     menu_sort_number?: number;
                     [index: string]: any;
                 };
-                [index: string]: any;
-            }[];
-            required?: boolean;
-            special?: boolean;
-            meta?: {
-                superplate?: {
-                    type_id?: number;
-                    type?: string;
-                };
-                featured?: {
-                    sort_number?: number;
-                    dates?: {
-                        start?: string;
-                        end?: string;
-                    };
+                is?: {
+                    disabled?: boolean;
+                    hidden?: boolean;
+                    out_of_stock?: boolean;
                 };
-                sort_number?: number;
-                menu_sort_number?: number;
-            };
-            category?: {
-                en?: string;
-            };
-            location?: string;
-            sku?: number;
-            item_number?: number;
-            image?: {
-                src?: string;
-            };
-            is_deleted?: boolean;
+                amount_off_exclusions?: any[];
+            }[];
+            min?: number;
+            max?: number;
             is?: {
                 disabled?: boolean;
                 hidden?: boolean;
-                meq_eligible?: boolean;
                 out_of_stock?: boolean;
-                deleted?: boolean;
-                featured?: boolean;
             };
+            meta?: {
+                sort_number?: number;
+                menu_sort_number?: number;
+                [index: string]: any;
+            };
+            [index: string]: any;
         }[];
-        is_disabled?: boolean;
-        name?: string;
-        is?: {
-            disabled?: boolean;
-            hidden?: boolean;
-        };
+        required?: boolean;
+        special?: boolean;
         meta?: {
+            superplate?: {
+                type_id?: number;
+                type?: string;
+            };
+            featured?: {
+                sort_number?: number;
+                dates?: {
+                    start?: string;
+                    end?: string;
+                };
+            };
             sort_number?: number;
             menu_sort_number?: number;
-            [index: string]: any;
+        };
+        category?: {
+            en?: string;
+        };
+        location?: string;
+        sku?: number;
+        item_number?: number;
+        image?: {
+            src?: string;
+        };
+        is_deleted?: boolean;
+        is?: {
+            disabled?: boolean;
+            hidden?: boolean;
+            meq_eligible?: boolean;
+            out_of_stock?: boolean;
+            deleted?: boolean;
+            featured?: boolean;
         };
     }[];
-    parent_id?: string;
-    location_brand?: string;
-    company?: string;
-    sector?: string;
+    is_disabled?: boolean;
+    name?: 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;
     };
     meta?: {
-        locked_by_user?: string;
-        last_modified_user?: string;
+        sort_number?: number;
+        menu_sort_number?: number;
         [index: string]: any;
     };
 }
-export declare type Group = any;
 export interface CognitionStore {
     uuid?: string;
     name?: string;
@@ -587,7 +619,7 @@ export interface CoolrLocations {
     };
     [index: string]: any;
 }
-export declare type CoolrImages = any[];
+export type CoolrImages = any[];
 export interface PostPartnerStandardcognitionShoppingcartBody {
     items?: {
         sku?: string;
@@ -597,7 +629,7 @@ export interface PostPartnerStandardcognitionShoppingcartBody {
     shoppingcart?: string;
     meta?: any;
 }
-export declare type PostPartnerStandardcognitionShoppingcartResponse = ShoppingCart;
+export type PostPartnerStandardcognitionShoppingcartResponse = ShoppingCart;
 export interface PostPartnerStandardcognitionShoppingcartRequest extends BaseRequest {
     body: PostPartnerStandardcognitionShoppingcartBody;
 }
@@ -605,14 +637,14 @@ export interface GetPartnerStandardcognitionLocationsQuery {
     _query?: string;
 }
 export interface GetPartnerStandardcognitionLocationsResponse {
-    groups?: LocationGroup;
+    groups?: LocationGroup[];
 }
 export interface GetPartnerStandardcognitionLocationsRequest extends BaseRequest, RequestQuery<GetPartnerStandardcognitionLocationsQuery> {
 }
 export interface GetPartnerStandardcognitionStoresQuery {
     _query?: string;
 }
-export declare type GetPartnerStandardcognitionStoresResponse = CognitionStore;
+export type GetPartnerStandardcognitionStoresResponse = CognitionStore;
 export interface GetPartnerStandardcognitionStoresRequest extends BaseRequest, RequestQuery<GetPartnerStandardcognitionStoresQuery> {
 }
 export interface PostPartnerStandardcognitionMenuBody {
@@ -622,7 +654,7 @@ export interface PostPartnerStandardcognitionMenuBody {
     jsonfile?: string;
     s3_link: string;
 }
-export declare type PostPartnerStandardcognitionMenuResponse = Menu;
+export type PostPartnerStandardcognitionMenuResponse = Menu;
 export interface PostPartnerStandardcognitionMenuRequest extends BaseRequest {
     body: PostPartnerStandardcognitionMenuBody;
 }