@compassdigital/sdk.typescript 3.0.0-beta.8 → 3.0.0-rc.1

package/src/interface/menu.ts

@@ -0,0 +1,649 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface Menu {
+  // menu
+  id?: string;
+  date?: {
+    created?: string;
+    modified?: string;
+    published?: string;
+  };
+  label?: {
+    en?: string;
+  };
+  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 Nutrition {
+  amount?: number;
+  unit?: string;
+}
+
+export interface Item {
+  // item
+  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?: 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?: OptionsGroup[];
+  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;
+  };
+  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;
+  };
+}
+
+export interface Group {
+  // group
+  id?: string;
+  label?: {
+    en?: string;
+    fr?: string;
+  };
+  items?: Item[];
+  is_disabled?: boolean;
+  name?: string;
+  is?: {
+    disabled?: boolean;
+    hidden?: boolean;
+  };
+  meta?: {
+    // chit sort order
+    sort_number?: number;
+    // menu sort order
+    menu_sort_number?: number;
+    [index: string]: any;
+  };
+}
+
+export interface Option {
+  // option
+  id?: string;
+  label?: {
+    en?: string;
+  };
+  price?: {
+    amount?: number;
+    currency?: string;
+  };
+  sku?: number;
+  nutrition?: {
+    kcal?: number;
+    calories?: Nutrition;
+  };
+  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?: AmountOffExclusionTypes[];
+}
+
+export interface OptionsGroup {
+  // modifier_group
+  id?: string;
+  label?: {
+    en?: string;
+  };
+  unique_name?: string;
+  items?: Option[];
+  min?: number;
+  max?: number;
+  is?: {
+    disabled?: boolean;
+    hidden?: boolean;
+    out_of_stock?: boolean;
+  };
+  meta?: {
+    // chit sort order
+    sort_number?: number;
+    // menu sort order
+    menu_sort_number?: number;
+    [index: string]: any;
+  };
+  [index: string]: any;
+}
+
+export interface OptionsGroupList {
+  modifier_groups?: OptionsGroup[];
+}
+
+export interface CreateOptionsGroup {
+  label: {
+    en?: string;
+  };
+  unique_name: string;
+  items?: Option[];
+  min?: number;
+  max?: number;
+  is?: {
+    disabled?: boolean;
+    hidden?: boolean;
+    out_of_stock?: boolean;
+  };
+  meta?: any;
+  // company
+  company: string;
+}
+
+export interface Success {
+  success?: boolean;
+}
+
+export interface Error {
+  error?: string;
+  code?: number;
+}
+
+export type AmountOffExclusionTypes = string;
+
+export interface Menus {
+  menus?: Menu[];
+}
+
+export interface Items {
+  items?: Item[];
+}
+
+export interface PatchMenu {
+  // menu
+  id?: string;
+  meta?: {
+    // User ID
+    locked_by_user?: string;
+  };
+}
+
+export interface ZippedExcelExport {
+  file?: string;
+  // Base64 encoded file format
+  format?: string;
+}
+
+// GET /menu/client/{client_id} - Get menu client
+
+export interface GetMenuClientPath {
+  client_id: string;
+}
+
+export type GetMenuClientResponse = Menus;
+
+export interface GetMenuClientRequest extends GetMenuClientPath {}
+
+// GET /menu - Get Menus or search for Menus
+
+export interface GetMenusQuery {
+  query: string;
+}
+
+export type GetMenusResponse = Menus;
+
+export interface GetMenusRequest extends GetMenusQuery {}
+
+// POST /menu - Create a new Menu
+
+export type PostMenuBody = Menu;
+
+export type PostMenuResponse = Menu;
+
+export interface PostMenuRequest {
+  body: PostMenuBody;
+}
+
+// HEAD /menu/{id} - Get an individual Menu
+
+export interface HeadMenuPath {
+  // menu
+  id: string;
+}
+
+export interface HeadMenuQuery {
+  // fields to return
+  _query?: string;
+}
+
+export type HeadMenuResponse = any;
+
+export interface HeadMenuRequest extends HeadMenuQuery, HeadMenuPath {}
+
+// GET /menu/{id} - Get an individual Menu
+
+export interface GetMenuPath {
+  // menu
+  id: string;
+}
+
+export interface GetMenuQuery {
+  // Show additional fields like hidden menu items, parent_id,company,sector,location_brand,overrides. Defaults to false
+  extended?: boolean;
+  // Show unlinked groups
+  show_unlinked?: boolean;
+  // fields to return
+  _query?: string;
+  nocache?: boolean;
+}
+
+export type GetMenuResponse = Menu;
+
+export interface GetMenuRequest extends GetMenuQuery, GetMenuPath {}
+
+// PUT /menu/{id} - Override a complete Menu
+
+export interface PutMenuPath {
+  // menu
+  id: string;
+}
+
+export interface PutMenuQuery {
+  // fields to return
+  _query?: string;
+}
+
+export type PutMenuBody = Menu;
+
+export type PutMenuResponse = Menu;
+
+export interface PutMenuRequest extends PutMenuQuery, PutMenuPath {
+  body: PutMenuBody;
+}
+
+// DELETE /menu/{id} - Delete a Menu
+
+export interface DeleteMenuPath {
+  // menu
+  id: string;
+}
+
+export interface DeleteMenuQuery {
+  // fields to return
+  _query?: string;
+}
+
+export type DeleteMenuResponse = Success;
+
+export interface DeleteMenuRequest extends DeleteMenuQuery, DeleteMenuPath {}
+
+// PATCH /menu/{id} - Update a menu
+
+export interface PatchMenuPath {
+  // menu
+  id: string;
+}
+
+export interface PatchMenuQuery {
+  // fields to return
+  _query?: string;
+}
+
+export type PatchMenuBody = PatchMenu;
+
+export type PatchMenuResponse = Menu;
+
+export interface PatchMenuRequest extends PatchMenuQuery, PatchMenuPath {
+  body: PatchMenuBody;
+}
+
+// POST /menu/import - Import an existing Menu
+
+export interface PostMenuImportMenuBody {
+  menu: {
+    // menu
+    menu?: string;
+  };
+}
+
+export type PostMenuImportMenuResponse = Menu;
+
+export interface PostMenuImportMenuRequest {
+  body: PostMenuImportMenuBody;
+}
+
+// GET /menu/item/{id} - Get menu item
+
+export interface GetMenuItemPath {
+  // Item ID
+  id: string;
+}
+
+export interface GetMenuItemQuery {
+  nocache?: boolean;
+}
+
+export type GetMenuItemResponse = Item;
+
+export interface GetMenuItemRequest extends GetMenuItemQuery, GetMenuItemPath {}
+
+// DELETE /menu/item/{id} - Delete a menu item
+
+export interface DeleteMenuItemPath {
+  // Item ID
+  id: string;
+}
+
+export type DeleteMenuItemResponse = Success;
+
+export interface DeleteMenuItemRequest extends DeleteMenuItemPath {}
+
+// POST /menu/item - Create a menu item
+
+export type PostMenuItemBody = Item;
+
+export type PostMenuItemResponse = Item;
+
+export interface PostMenuItemRequest {
+  body: PostMenuItemBody;
+}
+
+// GET /menu/items - Search for menu items
+
+export interface GetMenuItemsQuery {
+  query: string;
+}
+
+export type GetMenuItemsResponse = Items;
+
+export interface GetMenuItemsRequest extends GetMenuItemsQuery {}
+
+// POST /menu/items/import/{location} - trigger import items
+
+export interface PostMenuImportItemsCanteenPath {
+  // Location ID
+  location: string;
+}
+
+export type PostMenuImportItemsCanteenResponse = Success;
+
+export interface PostMenuImportItemsCanteenRequest extends PostMenuImportItemsCanteenPath {}
+
+// GET /menu/items/location/{location} - Get all menu items for a location
+
+export interface GetMenuLocationItemsPath {
+  // Location ID
+  location: string;
+}
+
+export type GetMenuLocationItemsResponse = Items;
+
+export interface GetMenuLocationItemsRequest extends GetMenuLocationItemsPath {}
+
+// GET /menu/item/random/location/{location} - Get a random item
+
+export interface GetMenuLocationItemRandomPath {
+  // Location ID
+  location: string;
+}
+
+export interface GetMenuLocationItemRandomQuery {
+  // The idfa of the requesting device
+  idfa?: string;
+  // Is this device being used in a public area
+  is_public?: boolean;
+  // The start of the session, prevents duplicates for any items voted on from the start time.
+  start_time?: number;
+}
+
+export type GetMenuLocationItemRandomResponse = Item;
+
+export interface GetMenuLocationItemRandomRequest
+  extends GetMenuLocationItemRandomQuery,
+    GetMenuLocationItemRandomPath {}
+
+// GET /menu/items/random/location/{location} - Get a set of random items
+
+export interface GetMenuLocationItemsRandomPath {
+  // Location ID
+  location: string;
+}
+
+export interface GetMenuLocationItemsRandomQuery {
+  // The idfa of the requesting device
+  idfa?: string;
+  // Is this device being used in a public area
+  is_public?: boolean;
+  // The number of items to return. Max is 5
+  count?: number;
+  // The start of the session, prevents duplicates for any items voted on from the start time.
+  start_time?: number;
+}
+
+export type GetMenuLocationItemsRandomResponse = Items;
+
+export interface GetMenuLocationItemsRandomRequest
+  extends GetMenuLocationItemsRandomQuery,
+    GetMenuLocationItemsRandomPath {}
+
+// GET /menu/sector/{sector} - Get menus that belong to sector
+
+export interface GetMenuSectorMenusPath {
+  // Sector ID
+  sector: string;
+}
+
+export type GetMenuSectorMenusResponse = Menus;
+
+export interface GetMenuSectorMenusRequest extends GetMenuSectorMenusPath {}
+
+// GET /menu/company/{company} - Get menus that belong to company
+
+export interface GetMenuCompanyMenusPath {
+  // Company ID
+  company: string;
+}
+
+export type GetMenuCompanyMenusResponse = Menus;
+
+export interface GetMenuCompanyMenusRequest extends GetMenuCompanyMenusPath {}
+
+// POST /menu/modifier/group - Create a new Menu Modifier Group
+
+export type PostMenuModifierGroupBody = CreateOptionsGroup;
+
+export type PostMenuModifierGroupResponse = OptionsGroup;
+
+export interface PostMenuModifierGroupRequest {
+  body: PostMenuModifierGroupBody;
+}
+
+// GET /menu/modifier/group/{id} - Get a Menu Modifier Group
+
+export interface GetMenuModifierGroupPath {
+  // modifier_group
+  id: string;
+}
+
+export type GetMenuModifierGroupResponse = OptionsGroup;
+
+export interface GetMenuModifierGroupRequest extends GetMenuModifierGroupPath {}
+
+// PUT /menu/modifier/group/{id} - Update a Menu Modifier Group
+
+export interface PutMenuModifierGroupPath {
+  // modifier_group
+  id: string;
+}
+
+export type PutMenuModifierGroupBody = OptionsGroup;
+
+export type PutMenuModifierGroupResponse = OptionsGroup;
+
+export interface PutMenuModifierGroupRequest extends PutMenuModifierGroupPath {
+  body: PutMenuModifierGroupBody;
+}
+
+// DELETE /menu/modifier/group/{id} - Delete a Menu Modifier Group
+
+export interface DeleteMenuModifierGroupPath {
+  // modifier_group
+  id: string;
+}
+
+export type DeleteMenuModifierGroupResponse = Success;
+
+export interface DeleteMenuModifierGroupRequest extends DeleteMenuModifierGroupPath {}
+
+// GET /menu/modifier/group/company/{company} - Get the modifier groups that belong to company
+
+export interface GetMenuCompanyModifierGroupsPath {
+  // Company ID
+  company: string;
+}
+
+export type GetMenuCompanyModifierGroupsResponse = OptionsGroupList;
+
+export interface GetMenuCompanyModifierGroupsRequest extends GetMenuCompanyModifierGroupsPath {}
+
+// GET /menu/modifier/group/company/{company}/export - Export company modifier groups to zipped excel file.
+
+export interface GetMenuCompanyModifierGroupsExportPath {
+  // Company ID
+  company: string;
+}
+
+export type GetMenuCompanyModifierGroupsExportResponse = ZippedExcelExport;
+
+export interface GetMenuCompanyModifierGroupsExportRequest
+  extends GetMenuCompanyModifierGroupsExportPath {}
+
+// GET /menu/{id}/export - Export menu set to zipped excel file.
+
+export interface GetMenuExportPath {
+  // menu; TODO: cannot use compassdigital.id as path parameter
+  id: string;
+}
+
+export type GetMenuExportResponse = ZippedExcelExport;
+
+export interface GetMenuExportRequest extends GetMenuExportPath {}

package/src/{message.ts → interface/message.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface Error {
   message?: string;
   code?: number;

package/src/{order.ts → interface/order.ts}

@@ -1,3 +1,5 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
 export interface CreateOrder {
   // brand
   location_brand?: string;
@@ -376,12 +378,12 @@ export interface GetOrderCustomerOrdersBrandRequest extends GetOrderCustomerOrde
 
 // GET /order/location/brand/{id} - Get all orders for a location Brand
 
-export interface GetOrderBrandOrdersPath {
+export interface GetOrderLocationBrandPath {
   // The location brand ID
   id: string;
 }
 
-export interface GetOrderBrandOrdersQuery {
+export interface GetOrderLocationBrandQuery {
   // Filter orders by their pickup date. Only return orders that have a date greater than or equal to the date in milliseconds.
   pickup_start?: number;
   // Filter orders by their pickup date. Only return orders that have a date less than or equal to the date in milliseconds.
@@ -398,11 +400,11 @@ export interface GetOrderBrandOrdersQuery {
   limit?: number;
 }
 
-export type GetOrderBrandOrdersResponse = Orders;
+export type GetOrderLocationBrandResponse = Orders;
 
-export interface GetOrderBrandOrdersRequest
-  extends GetOrderBrandOrdersQuery,
-    GetOrderBrandOrdersPath {}
+export interface GetOrderLocationBrandRequest
+  extends GetOrderLocationBrandQuery,
+    GetOrderLocationBrandPath {}
 
 // GET /order/location/{id} - Get all orders for a location
 
@@ -450,6 +452,8 @@ export interface GetOrderGroupOrdersQuery {
   end?: number;
   // Filter orders by their order type
   order_type?: string;
+  // Filter orders by brand ID. Only return orders that involve brand ID, either as the only brand, or as part of a market place order.
+  brand?: string;
 }
 
 export interface GetOrderGroupOrdersResponse {
@@ -459,3 +463,14 @@ export interface GetOrderGroupOrdersResponse {
 export interface GetOrderGroupOrdersRequest
   extends GetOrderGroupOrdersQuery,
     GetOrderGroupOrdersPath {}
+
+// PATCH /order/{id}/checkin - Accept an order by checking in
+
+export interface PatchOrderCheckinPath {
+  // The order ID
+  id: string;
+}
+
+export type PatchOrderCheckinResponse = Order;
+
+export interface PatchOrderCheckinRequest extends PatchOrderCheckinPath {}