@compassdigital/sdk.typescript 3.0.0-beta.19 → 3.0.0-beta.21

package/src/interface/partner.ts

@@ -42,14 +42,25 @@ export interface ShoppingCart {
     _loyalty?: {
       amount?: number;
     };
-    meta?: any;
+    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;
@@ -291,6 +302,8 @@ export interface LocationGroup {
       brand?: string;
       // location
       location?: string;
+      // location group
+      group?: string;
       // payment
       payment_provider?: string;
       location_description?: string;
@@ -397,6 +410,235 @@ export type Hours = any;
 
 export type DeliveryHours = any;
 
+export interface Menu {
+  // menu
+  id?: string;
+  date?: {
+    created?: string;
+    modified?: string;
+    published?: string;
+  };
+  label?: {
+    en?: string;
+  };
+  groups?: {
+    // group
+    id?: string;
+    label?: {
+      en?: string;
+      fr?: string;
+    };
+    items?: {
+      // 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?: 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;
+        };
+        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;
+        };
+        meta?: {
+          // chit sort order
+          sort_number?: number;
+          // menu sort order
+          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;
+          };
+        };
+        // 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;
+      };
+    }[];
+    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;
+    };
+  }[];
+  // 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 type Group = any;
+
 export interface CognitionStore {
   // UUID for external store
   uuid?: string;
@@ -433,14 +675,14 @@ export type CoolrImages = any[];
 // POST /partner/standardcognition/shoppingcart - Calculates a shoppingcart
 
 export interface PostPartnerStandardcognitionShoppingcartBody {
-  items?: {
+  items: {
     sku?: string;
     quantity?: number;
   }[];
   // brand
-  location_brand?: string;
-  // shoppingcart
-  shoppingcart?: string;
+  location_brand: string;
+  // CDL shoppingcart id. If provided, items will be added to this shoppingcart
+  shoppingcart: string;
 }
 
 export type PostPartnerStandardcognitionShoppingcartResponse = ShoppingCart;
@@ -463,6 +705,25 @@ export type GetPartnerStandardcognitionStoresResponse = CognitionStore;
 
 export type GetPartnerStandardcognitionStoresRequest = {};
 
+// POST /partner/standardcognition/menu - Create new Standard Cognition menu from JSON files
+
+export interface PostPartnerStandardcognitionMenuBody {
+  // CDL company ID
+  company: string;
+  // CDL sector ID
+  sector: string;
+  // CDL location brand ID
+  location_brand: string;
+  // Link for S3 menu file provided by Standard Cognition
+  s3_link: string;
+}
+
+export type PostPartnerStandardcognitionMenuResponse = Menu;
+
+export interface PostPartnerStandardcognitionMenuRequest {
+  body: PostPartnerStandardcognitionMenuBody;
+}
+
 // GET /partner/coolr/locations - Gets the locations where Coolr is available
 
 export interface GetPartnerCoolrLocationsResponse {

package/src/interface/shoppingcart.ts

@@ -32,14 +32,25 @@ export interface Item {
   _loyalty?: {
     amount?: number;
   };
-  meta?: any;
+  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;

package/src/interface/user.ts

@@ -33,12 +33,21 @@ export interface User {
       send_emails_date_updated?: string;
     };
     mealplan_added_date?: string;
+    // phone verification details
+    phone_verification?: {
+      verification_code?: string;
+      date_generated?: number;
+      failed_attempts?: number;
+      consecutive_failed_attempts?: number;
+    };
     [index: string]: any;
   };
   is?: {
     disabled?: boolean;
     // If the users email is verified
     verified?: boolean;
+    // User phone number verification
+    phone_verified?: boolean;
   };
   permissions?: Scopes;
   // User location group
@@ -586,3 +595,21 @@ export type PutUserVerifyUserEmailResponse = success;
 export interface PutUserVerifyUserEmailRequest extends PutUserVerifyUserEmailPath {
   body: PutUserVerifyUserEmailBody;
 }
+
+// PUT /user/{id}/verification/phone - Send phone verification to user
+
+export interface PutUserVerificationPhonePath {
+  // realm
+  id: string;
+}
+
+export interface PutUserVerificationPhoneBody {
+  // User phone number to be verified
+  phone: string;
+}
+
+export type PutUserVerificationPhoneResponse = success;
+
+export interface PutUserVerificationPhoneRequest extends PutUserVerificationPhonePath {
+  body: PutUserVerificationPhoneBody;
+}