@compassdigital/sdk.typescript 3.38.0 → 3.40.0

package/src/interface/partner.ts

@@ -17,63 +17,7 @@ export interface ShoppingCart {
   // brand
   brand?: string;
   date?: any;
-  items?: {
-    // item
-    id: string;
-    // index
-    _index?: string;
-    quantity: number;
-    unit?: number;
-    price?: {
-      amount?: number;
-    };
-    // Final item price after LTO/Bundle/BOGO etc is applied on the item.
-    sale_price?: {
-      active?: boolean;
-      amount?: number;
-    };
-    // Subtotal of the item including all options
-    _subtotal?: {
-      amount?: number;
-    };
-    // Promo applied to this item
-    _promo?: {
-      amount?: number;
-    };
-    meta?: {
-      // menu id
-      menu?: string;
-      // brand id
-      brand?: string;
-      [index: string]: any;
-    };
-    options?: {
-      id?: string;
-      label?: {
-        en?: string;
-      };
-      meta?: any;
-      items?: {
-        // option
-        id?: string;
-        label?: {
-          en?: string;
-        };
-        // index
-        _index?: string;
-        meta?: any;
-        quantity?: number;
-        amount_off_exclusions?: string[];
-      }[];
-    }[];
-    // Details about discount like BOGO, LTO, Bundle etc.
-    item_discount?: any;
-    // user specified instructions for the item
-    special_instructions?: string;
-    amount_off_exclusions?: string[];
-    added_on?: string;
-    [index: string]: any;
-  }[];
+  items?: Item[];
   sub_total?: {
     amount?: number;
   };
@@ -84,6 +28,17 @@ export interface ShoppingCart {
     amount?: number;
     app?: string;
   };
+  //@deprecated
+  loyalty?: {
+    coupon?: {
+      code?: string;
+      amount_off?: number;
+      amount?: number;
+      name?: string;
+    };
+    // Points to be earned for this shopping cart total
+    order_loyalty_points?: boolean;
+  };
   discount?: {
     code?: string;
     amount_off?: number;
@@ -119,19 +74,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;
@@ -154,8 +99,10 @@ export interface ShoppingCart {
     type?: string;
     // If an order should be paid with meal exchange. If true, this will calculate meals total.
     mx_cart?: boolean;
-    // If a user's email domain is a match in a sites list of tax exempt domains
-    domain_tax_exempt?: boolean;
+    // If a user's email or email domain is a match in a sites list of tax exempt emails or domains
+    email_tax_exempt?: boolean;
+    // Indicates to clients that a tax recalculation is required
+    tax_calculation_required?: boolean;
   };
   meta?: {
     // Raw request from any vendor integrated with CDL
@@ -164,9 +111,83 @@ export interface ShoppingCart {
   };
 }
 
-export type Item = any;
+export interface Item {
+  // item
+  id: string;
+  // index
+  _index?: string;
+  quantity: number;
+  unit?: number;
+  price?: {
+    amount?: number;
+  };
+  // Final item price after LTO/Bundle/BOGO etc is applied on the item.
+  sale_price?: {
+    active?: boolean;
+    amount?: number;
+  };
+  // Subtotal of the item including all options
+  _subtotal?: {
+    amount?: number;
+  };
+  // Promo applied to this item
+  _promo?: {
+    amount?: number;
+  };
+  meta?: {
+    // menu id
+    menu?: string;
+    // brand id
+    brand?: string;
+    [index: string]: any;
+  };
+  options?: {
+    id?: string;
+    label?: {
+      en?: string;
+    };
+    meta?: any;
+    items?: {
+      // option
+      id?: string;
+      label?: {
+        en?: string;
+      };
+      // index
+      _index?: string;
+      meta?: any;
+      quantity?: number;
+      amount_off_exclusions?: string[];
+    }[];
+  }[];
+  // Details about discount like BOGO, LTO, Bundle etc.
+  item_discount?: any;
+  // user specified instructions for the item
+  special_instructions?: string;
+  amount_off_exclusions?: string[];
+  added_on?: string;
+  [index: string]: any;
+}
 
-export type taxes = ShoppingCart["taxes"];
+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 {
   // group
@@ -178,245 +199,264 @@ export interface LocationGroup {
   };
   // Distance in meters from the group
   distance?: number;
-  locations?: {
-    // location
-    id?: string;
-    operation_id?: number;
-    name?: string;
+  locations?: Location[];
+  address?: Address;
+  meta?: {
+    [index: string]: any;
+  };
+  style?: any;
+  [index: string]: any;
+}
+
+export interface Location {
+  // 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;
+  // group
+  location_group?: string;
+  // multigroup
+  location_multigroup?: string;
+  // sector
+  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?: {
-      // brand
-      id?: string;
-      // sector
-      sector?: string;
-      name?: string;
-      label?: {
-        en?: string;
-        fr?: string;
-      };
-      timezone?: string;
-      description?: string;
-      latitude?: number;
-      longitude?: number;
-      address?: {
-        // Suite number of the address, if applicable
-        suite?: string;
-        // First line of the address, should include street number
-        address?: string;
-        // City of the address
-        city?: string;
-        // State of the address, also province in Canada
-        state?: string;
-        // Country of the address
-        country?: string;
-        // Zip code or postal code of the address
-        zip?: string;
-        coordinates?: {
-          // latitude of the the address
-          latitude?: number;
-          // longitude of the the address
-          longitude?: number;
-        };
-      };
-      menus?: {
-        // menu
-        id?: string;
-        label?: {
-          en?: string;
-        };
-        hours?: any[];
-        is_pickup?: boolean;
-        is_delivery?: boolean;
-        is_frictionless?: boolean;
-      }[];
-      date?: {
-        created?: string;
-      };
-      hours?: {
-        // hours
-        id?: string;
-        date?: {
-          start?: string;
-          end?: string;
-        };
-        day?: {
-          start?: number;
-          end?: number;
-        };
-        hours?: string;
-      }[];
-      deliveryHours?: {
-        // hours
-        id?: string;
-        day?: {
-          start?: number;
-          end?: number;
-        };
-        hours?: string;
-      }[];
-      style?: any;
-      // pos
-      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;
-        // admin panel toggle
-        special_instructions?: boolean;
-        [index: string]: any;
-      };
-      // brand
-      brand?: string;
-      // location
-      location?: string;
-      // location group
-      group?: string;
-      // payment
-      payment_provider?: string;
-      location_description?: string;
-      // company
-      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;
-    // group
-    location_group?: string;
-    // multigroup
-    location_multigroup?: string;
-    // sector
-    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 {
+  // brand
+  id?: string;
+  // sector
+  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
+  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;
+    // admin panel toggle
+    special_instructions?: boolean;
+    [index: string]: any;
+  };
+  // brand
+  brand?: string;
+  // location
+  location?: string;
+  // location group
+  group?: string;
+  // payment
+  payment_provider?: string;
+  location_description?: string;
+  // company
+  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 type Location = any;
-
-export type Brand = any;
+export interface Address {
+  // Suite number of the address, if applicable
+  suite?: string;
+  // First line of the address, should include street number
+  address?: string;
+  // City of the address
+  city?: string;
+  // State of the address, also province in Canada
+  state?: string;
+  // Country of the address
+  country?: string;
+  // Zip code or postal code of the address
+  zip?: string;
+  coordinates?: {
+    // latitude of the the address
+    latitude?: number;
+    // longitude of the the address
+    longitude?: number;
+  };
+}
 
-export type Address = Brand["address"];
+export interface MenuHours {
+  // menu
+  id?: string;
+  label?: {
+    en?: string;
+  };
+  hours?: Hours[];
+  is_pickup?: boolean;
+  is_delivery?: boolean;
+  is_frictionless?: boolean;
+}
 
-export type MenuHours = any;
+export interface Hours {
+  // hours
+  id?: string;
+  date?: {
+    deleted?: string;
+    start?: string;
+    end?: string;
+  };
+  day?: {
+    start?: number;
+    end?: number;
+  };
+  hours?: string;
+}
 
-export type Hours = any;
+export interface DeliveryHours {
+  // hours
+  id?: string;
+  day?: {
+    start?: number;
+    end?: number;
+  };
+  hours?: string;
+}
 
-export type DeliveryHours = any;
+export interface WaitTime {
+  // maxium wait time to the next time slot in minutes
+  max: number;
+  // minimum wait time to the next time slot in minutes
+  min: number;
+  // the epoch timestamp of the next available ready time for a station
+  ready_time: number;
+}
 
 export interface Menu {
   // menu
@@ -429,132 +469,141 @@ export interface Menu {
   label?: {
     en?: string;
   };
-  groups?: {
-    // group
+  groups?: Group[];
+  // menu
+  parent_id?: string;
+  // brand
+  location_brand?: string;
+  // company
+  company?: string;
+  // sector
+  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?: {
+    // User ID
+    locked_by_user?: string;
+    // User ID
+    last_modified_user?: string;
+    [index: string]: any;
+  };
+}
+
+export interface Group {
+  // group
+  id?: string;
+  label?: {
+    en?: string;
+    fr?: string;
+  };
+  items?: {
+    // item
     id?: string;
     label?: {
       en?: string;
-      fr?: string;
     };
-    items?: {
-      // item
+    description?: {
+      en?: string;
+    };
+    price?: {
+      amount?: number;
+      currency?: string;
+    };
+    // Meal exchange value of the item
+    meal_value?: number;
+    sale_price?: {
+      amount?: number;
+      currency?: string;
+    };
+    // The number of units that belong to this item. For example, a dozen doughnuts should have a unit value of 12
+    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?: {
+      // modifier_group
       id?: string;
       label?: {
         en?: string;
       };
-      description?: {
-        en?: string;
-      };
-      price?: {
-        amount?: number;
-        currency?: string;
-      };
-      // Meal exchange value of the item
-      meal_value?: number;
-      sale_price?: {
-        amount?: number;
-        currency?: string;
-      };
-      // The number of units that belong to this item. For example, a dozen doughnuts should have a unit value of 12
-      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?: {
-        // modifier_group
+      unique_name?: string;
+      items?: {
+        // option
         id?: string;
         label?: {
           en?: string;
         };
-        unique_name?: string;
-        items?: {
-          // option
-          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?: {
-            // chit sort order
-            sort_number?: number;
-            // menu sort order
-            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?: {
           // chit sort order
           sort_number?: number;
@@ -562,91 +611,82 @@ export interface Menu {
           menu_sort_number?: number;
           [index: string]: any;
         };
-        [index: string]: any;
+        is?: {
+          disabled?: boolean;
+          hidden?: boolean;
+          out_of_stock?: boolean;
+        };
+        amount_off_exclusions?: any[];
       }[];
-      required?: boolean;
-      special?: boolean;
+      min?: number;
+      max?: number;
+      is?: {
+        disabled?: boolean;
+        hidden?: boolean;
+        out_of_stock?: boolean;
+      };
       meta?: {
-        superplate?: {
-          type_id?: number;
-          type?: string;
-        };
-        featured?: {
-          sort_number?: number;
-          dates?: {
-            start?: string;
-            end?: string;
-          };
-        };
         // chit sort order
         sort_number?: number;
         // menu sort order
         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;
-      };
+      [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;
+        };
+      };
       // chit sort order
       sort_number?: number;
       // menu sort order
       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;
     };
   }[];
-  // menu
-  parent_id?: string;
-  // brand
-  location_brand?: string;
-  // company
-  company?: string;
-  // sector
-  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?: {
-    // User ID
-    locked_by_user?: string;
-    // User ID
-    last_modified_user?: string;
+    // chit sort order
+    sort_number?: number;
+    // menu sort order
+    menu_sort_number?: number;
     [index: string]: any;
   };
 }
 
-export type Group = any;
-
 export interface CognitionStore {
   // UUID for external store
   uuid?: string;
@@ -703,17 +743,31 @@ export interface PostPartnerStandardcognitionShoppingcartRequest extends BaseReq
 
 // GET /partner/standardcognition/locations - Gets the locations where Standard Cognition is available
 
+export interface GetPartnerStandardcognitionLocationsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export interface GetPartnerStandardcognitionLocationsResponse {
-  groups?: LocationGroup;
+  groups?: LocationGroup[];
 }
 
-export interface GetPartnerStandardcognitionLocationsRequest extends BaseRequest {}
+export interface GetPartnerStandardcognitionLocationsRequest
+  extends BaseRequest,
+    RequestQuery<GetPartnerStandardcognitionLocationsQuery> {}
 
 // GET /partner/standardcognition/stores - Gets the UUID for all the Standard Cognition external locations
 
+export interface GetPartnerStandardcognitionStoresQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export type GetPartnerStandardcognitionStoresResponse = CognitionStore;
 
-export interface GetPartnerStandardcognitionStoresRequest extends BaseRequest {}
+export interface GetPartnerStandardcognitionStoresRequest
+  extends BaseRequest,
+    RequestQuery<GetPartnerStandardcognitionStoresQuery> {}
 
 // POST /partner/standardcognition/menu - Create new Standard Cognition menu from JSON files
 
@@ -738,11 +792,18 @@ export interface PostPartnerStandardcognitionMenuRequest extends BaseRequest {
 
 // GET /partner/coolr/locations - Gets the locations where Coolr is available
 
+export interface GetPartnerCoolrLocationsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export interface GetPartnerCoolrLocationsResponse {
   locations?: CoolrLocations[];
 }
 
-export interface GetPartnerCoolrLocationsRequest extends BaseRequest {}
+export interface GetPartnerCoolrLocationsRequest
+  extends BaseRequest,
+    RequestQuery<GetPartnerCoolrLocationsQuery> {}
 
 // GET /partner/coolr/{id}/images - Gets the latest images for Coolr Location AssetID
 
@@ -751,16 +812,31 @@ export interface GetPartnerCoolrImagesPath {
   id: string;
 }
 
+export interface GetPartnerCoolrImagesQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export interface GetPartnerCoolrImagesResponse {
   images?: CoolrImages;
 }
 
-export interface GetPartnerCoolrImagesRequest extends BaseRequest, GetPartnerCoolrImagesPath {}
+export interface GetPartnerCoolrImagesRequest
+  extends BaseRequest,
+    RequestQuery<GetPartnerCoolrImagesQuery>,
+    GetPartnerCoolrImagesPath {}
 
 // GET /partner/swagger.json
 
+export interface GetPartnerSwaggerQuery {
+  // Graphql query string
+  _query?: string;
+}
+
 export interface GetPartnerSwaggerResponse {
   [index: string]: any;
 }
 
-export interface GetPartnerSwaggerRequest extends BaseRequest {}
+export interface GetPartnerSwaggerRequest
+  extends BaseRequest,
+    RequestQuery<GetPartnerSwaggerQuery> {}