@compassdigital/sdk.typescript 4.114.0 → 4.116.0

package/lib/interface/consumer.d.ts

@@ -124,8 +124,8 @@ export interface OrderMeta {
 }
 export interface CustomerOrderBrandDTO {
     id: string;
-    name: string;
-    location_description: string;
+    name?: string;
+    location_description?: string;
 }
 export interface OrderDate {
     accepted?: string;
@@ -586,11 +586,223 @@ export interface HeroImage {
     end: string;
     images: string[];
 }
+export interface HomePageOrder {
+    meta?: {
+        [index: string]: any;
+    } & OrderMeta;
+    id?: string;
+    reorder_eligibility?: 'eligible' | 'order_type_ineligible' | 'location_ineligible' | 'active_order' | 'old_order' | 'marketplace_order' | 'duplicate_order' | 'brand_unavailable' | 'menu_unavailable' | 'items_unavailable' | 'refunded_order' | 'modifiers_unavailable' | 'modified_items' | 'cancelled_order';
+    location_brand?: string;
+    location?: string;
+    date?: OrderDate;
+    details?: OrderDetails;
+    requested_date?: string;
+    refunds?: OrderRefundItem[];
+    customer?: string;
+    pickup_id?: string;
+    payment?: OrderPayment;
+    mealplan?: OrderMealplan;
+    meal_swipes?: OrderMealSwipes;
+    is?: OrderIs;
+    issue?: OrderIssue;
+    shoppingcart?: string;
+}
+export interface ConsumerAddress {
+    suite?: string;
+    address?: string;
+    city?: string;
+    state?: string;
+    country?: string;
+    zip?: string;
+    coordinates?: {
+        latitude?: number;
+        longitude?: number;
+    };
+}
+export interface ConsumerMenuHours {
+    id?: string;
+    label?: {
+        en?: string;
+    };
+    hours?: Record<string, any>[];
+    is_pickup?: boolean;
+    is_delivery?: boolean;
+    is_frictionless?: boolean;
+    state?: Record<string, any>;
+    is_disabled?: boolean;
+}
+export interface ConsumerHours {
+    id?: string;
+    date?: {
+        deleted?: string;
+        start?: string;
+        end?: string;
+    };
+    day?: {
+        start?: number;
+        end?: number;
+    };
+    hours?: string;
+}
+export interface ConsumerDeliveryHours {
+    id?: string;
+    day?: {
+        start?: number;
+        end?: number;
+    };
+    hours?: string;
+}
+export interface ConsumerWaitTime {
+    max: number;
+    min: number;
+    ready_time: number;
+}
+export interface ConsumerBrand {
+    id?: string;
+    sector?: string;
+    name?: string;
+    label?: {
+        en?: string;
+        fr?: string;
+    };
+    timezone?: string;
+    description?: string;
+    latitude?: number;
+    longitude?: number;
+    address?: ConsumerAddress;
+    menus?: ConsumerMenuHours[];
+    date?: {
+        deleted?: string;
+        created?: string;
+    };
+    hours?: ConsumerHours[];
+    deliveryHours?: ConsumerDeliveryHours[];
+    style?: {
+        logo?: string | null;
+        main_logo?: string | null;
+        alt_logo?: string | null;
+    };
+    pos?: string;
+    terminals?: Record<string, any>[];
+    device_mapping?: Record<string, 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;
+    };
+    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;
+    descriptions?: {
+        location: {
+            en?: string;
+            fr?: string;
+        };
+    };
+    estimated_wait_time?: {
+        delivery?: ConsumerWaitTime;
+        pickup?: ConsumerWaitTime;
+    };
+    state?: {
+        pickup?: Record<string, any>;
+        delivery?: Record<string, any>;
+    };
+}
+export interface ConsumerLocation {
+    id?: string;
+    operation_id?: number;
+    name?: string;
+    label?: {
+        en?: string;
+        fr?: string;
+    };
+    search?: string[];
+    app?: string;
+    address?: ConsumerAddress;
+    latitude?: number;
+    longitude?: number;
+    brands?: ConsumerBrand[];
+    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?: ConsumerHours[];
+        deliveryHours?: ConsumerDeliveryHours[];
+        service_fee: {
+            type?: string;
+            value?: number;
+        };
+    };
+}
+export interface ConsumerGroup {
+    id?: string;
+    name?: string;
+    label?: {
+        en?: string;
+        fr?: string;
+    };
+    distance?: number;
+    locations?: ConsumerLocation[];
+    address?: ConsumerAddress;
+    meta?: Record<string, any>;
+    style?: {
+        logo?: string | null;
+        main_logo?: string | null;
+        alt_logo?: string | null;
+    };
+    timezone?: string;
+}
 export interface HomePageResponse {
     greetingMessage: DiverseGreetingMessages;
     heroImages: HeroImage;
-    orders?: Record<string, any>[];
-    location?: Record<string, any>;
+    orders?: HomePageOrder[];
+    location?: ConsumerGroup;
 }
 export interface FrictionlessCheckinResponse {
     id: string;
@@ -646,10 +858,10 @@ export interface GetConsumerLocationGroupResponse {
 export interface GetConsumerLocationMultiGroupResponse {
     id: string;
     name: string;
-    groups: Record<string, any>[];
+    groups: ConsumerGroup[];
 }
 export interface ConsumerGetActiveMenusResponse {
-    menus: Record<string, any>[];
+    menus: ConsumerMenuHours[];
 }
 export interface GetConsumerMenuResponse {
     id: string;
@@ -661,7 +873,7 @@ export interface GetConsumerMenuResponse {
     label?: {
         en?: string;
     };
-    groups: Record<string, any>[];
+    groups: ConsumerGroup[];
     parent_id: string;
     location_brand?: string;
     company?: string;
@@ -682,9 +894,161 @@ export interface GetConsumerMenuResponse {
     };
     meta?: Record<string, any>;
 }
+export interface ConsumerOption {
+    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?: Record<string, any>;
+    };
+    certified?: {
+        vegan?: boolean;
+    };
+    is?: {
+        disabled?: boolean;
+        hidden?: boolean;
+        out_of_stock?: boolean;
+    };
+    amount_off_exclusions?: Record<string, any>[];
+    line_route?: string;
+}
+export interface ConsumerOptionsGroup {
+    id?: string;
+    label?: {
+        en?: string;
+    };
+    unique_name?: string;
+    name?: string;
+    items?: ConsumerOption[];
+    min?: number;
+    max?: number;
+    is?: {
+        disabled?: boolean;
+        hidden?: boolean;
+        out_of_stock?: boolean;
+        incremental?: boolean;
+        surcharge_limit?: boolean;
+    };
+    limit?: number;
+}
+export interface ConsumerItem {
+    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?: Record<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?: ConsumerOptionsGroup[];
+    required?: boolean;
+    special?: boolean;
+    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;
+    };
+}
 export interface GetConsumerMenuItemsResponse {
     meta?: Record<string, any>;
-    items: Record<string, any>[];
+    items: ConsumerItem[];
 }
 export interface PostConsumerRecommendedRequest {
     excludedItems: string[];
@@ -692,11 +1056,19 @@ export interface PostConsumerRecommendedRequest {
 export interface PostConsumerRecommendedResponse {
     items: string[];
 }
+export interface ConsumerTimeslot {
+    id?: number;
+    brand_id?: string;
+    start_time?: string;
+    duration?: string;
+    is_available?: boolean;
+    number_orders?: number;
+}
 export interface PostConsumerLocationMarketplaceTimeslotsResponse {
-    timeslots?: Record<string, any>[];
+    timeslots?: ConsumerTimeslot[];
 }
 export interface PostConsumerLocationMarketplaceTimeslotsDeliveryResponse {
-    timeslots?: Record<string, any>[];
+    timeslots?: ConsumerTimeslot[];
 }
 export interface ConsumerDeleteUserResponse {
     success: boolean;
@@ -708,6 +1080,41 @@ export interface PostConsumerUserChangePasswordRequest {
     password: string;
     new_password: string;
 }
+export interface ConsumerCashlessLog {
+    added?: string;
+    deleted?: string;
+}
+export interface ConsumerUserMeta {
+    marketing_opt_in?: boolean;
+    marketing_opt_in_date?: string;
+    marketing_opt_in_source?: Record<string, any>;
+    order_status_notification?: {
+        send_emails?: boolean;
+        send_emails_date_updated?: string;
+    };
+    mealplan_added_date?: string;
+    login_limit?: {
+        login_attempts?: number;
+        last_attempt_date?: string;
+    };
+    password_verification?: {
+        attempts?: number;
+        first_attempted?: string;
+    };
+    phone_verification?: {
+        verification_code?: string;
+        date_generated?: number;
+        failed_attempts?: number;
+        consecutive_failed_attempts?: number;
+    };
+    cashless?: {
+        stipend?: ConsumerCashlessLog;
+        voucher?: ConsumerCashlessLog;
+        badge_pay?: ConsumerCashlessLog;
+        coupon_voucher?: ConsumerCashlessLog;
+    };
+    last_location?: string;
+}
 export interface PostConsumerUserChangePasswordResponse {
     id: string;
     email: string;
@@ -720,12 +1127,17 @@ export interface PostConsumerUserChangePasswordResponse {
         modified?: string;
     };
     gender?: Record<string, any>;
-    meta?: Record<string, any>;
+    meta?: ConsumerUserMeta;
     is?: {
         locked_out?: boolean;
         verified?: boolean;
     };
 }
+export type ConsumerAcl = Record<string, any>;
+export interface ConsumerScopes {
+    scopes?: string[];
+    acl?: ConsumerAcl;
+}
 export interface PutConsumerUserRequest {
     id?: string;
     email?: string;
@@ -743,7 +1155,7 @@ export interface PutConsumerUserRequest {
     phone_country_code?: string;
     realm?: string;
     gender?: Record<string, any>;
-    meta?: Record<string, any>;
+    meta?: ConsumerUserMeta;
     is?: {
         disabled?: boolean;
         locked_out?: boolean;
@@ -752,7 +1164,7 @@ export interface PutConsumerUserRequest {
         deleted?: boolean;
         placeholder?: boolean;
     };
-    permissions?: Record<string, any>;
+    permissions?: ConsumerScopes;
     location_group?: string;
     ssoId?: string;
 }
@@ -773,7 +1185,9 @@ export interface PutConsumerUserResponse {
     phone_country_code?: string;
     realm?: string;
     gender?: Record<string, any>;
-    meta?: Record<string, any>;
+    meta?: {
+        [index: string]: any;
+    } & ConsumerUserMeta;
     is?: {
         disabled?: boolean;
         locked_out?: boolean;
@@ -782,7 +1196,7 @@ export interface PutConsumerUserResponse {
         deleted?: boolean;
         placeholder?: boolean;
     };
-    permissions?: Record<string, any>;
+    permissions?: ConsumerScopes;
     location_group?: string;
     ssoId?: string;
 }
@@ -803,7 +1217,9 @@ export interface GetConsumerUserResponse {
     phone_country_code?: string;
     realm?: string;
     gender?: Record<string, any>;
-    meta?: Record<string, any>;
+    meta?: {
+        [index: string]: any;
+    } & ConsumerUserMeta;
     is?: {
         disabled?: boolean;
         locked_out?: boolean;
@@ -812,7 +1228,7 @@ export interface GetConsumerUserResponse {
         deleted?: boolean;
         placeholder?: boolean;
     };
-    permissions?: Record<string, any>;
+    permissions?: ConsumerScopes;
     location_group?: string;
     ssoId?: string;
 }
@@ -934,6 +1350,36 @@ export interface PutConsumerShoppingCartResponse {
         system365?: boolean;
     };
 }
+export interface PostConsumerPromoValidateRequest {
+    code?: string;
+    email?: string;
+    app?: string;
+    realm?: string;
+    location_brand?: string;
+    shoppingcart?: {
+        id?: string;
+        date_created?: string;
+        items?: ShoppingcartItem[];
+    };
+    totals?: {
+        amount?: number;
+        currency?: string;
+    };
+}
+export interface ConsumerAppliedDiscount {
+    type?: string;
+    amount_off?: number;
+    percent_off?: number;
+    amount_limit?: number;
+}
+export interface ConsumerVoucher {
+    provider?: Record<string, any>;
+    code?: string;
+    valid?: boolean;
+    discount?: ConsumerAppliedDiscount;
+    app?: string;
+    provider_data?: ShoppingcartFPValidationData;
+}
 export interface HealthCheckControllerExecuteQuery {
     _query?: string;
 }
@@ -1093,4 +1539,6 @@ export interface PutConsumerShoppingcartPath {
 }
 export type PutConsumerShoppingcartBody = PutConsumerShoppingCartItemsRequest;
 export type PutConsumerShoppingcartResponse = PutConsumerShoppingCartResponse;
+export type PostConsumerPromoValidateBody = PostConsumerPromoValidateRequest;
+export type PostConsumerPromoValidateResponse = ConsumerVoucher;
 //# sourceMappingURL=consumer.d.ts.map