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

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

@@ -1,5 +1,3 @@
-// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
-
 export interface Error {
   error?: string;
   message?: string;
@@ -47,8 +45,6 @@ export interface AuthPostBodyResponse {
 export interface GetKdsDevicesQuery {
   // Unit numbers string separated with commas
   unitNumber: string;
-  // Do not return cached device information
-  nocache?: boolean;
 }
 
 export type GetKdsDevicesResponse = Units;

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

@@ -1,5 +1,3 @@
-// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
-
 export interface POS {
   // pos
   id?: string;
@@ -135,8 +133,6 @@ export interface Brand {
   brand?: string;
   // location
   location?: string;
-  // location group
-  group?: string;
   // payment
   payment_provider?: string;
   location_description?: string;
@@ -343,7 +339,7 @@ export interface PostOrPatchDeliveryDestination {
 }
 
 export interface DeliveryDestination {
-  // delivery_destination
+  // ID of the delivery destination
   id?: string;
   // Name of the delivery destination
   name: string;
@@ -753,59 +749,53 @@ export interface PostLocationGroupDeliverydestinationRequest
   body: PostLocationGroupDeliverydestinationBody;
 }
 
-// PATCH /location/group/{id}/deliverydestination - Patch single or multiple delivery destinations
+// GET /location/group/{id}/deliverydestination/{delivery_destination} - Get a delivery destination
 
-export interface PatchLocationGroupDeliverydestinationPath {
+export interface GetLocationGroupDeliverydestinationPath {
   // Group ID
   id: string;
+  // Delivery Destination ID
+  delivery_destination: string;
 }
 
-export interface PatchLocationGroupDeliverydestinationBody {
-  delivery_destinations?: PostOrPatchDeliveryDestination;
-}
-
-export interface PatchLocationGroupDeliverydestinationResponse {
-  delivery_destinations?: DeliveryDestination;
-}
+export type GetLocationGroupDeliverydestinationResponse = DeliveryDestination;
 
-export interface PatchLocationGroupDeliverydestinationRequest
-  extends PatchLocationGroupDeliverydestinationPath {
-  body: PatchLocationGroupDeliverydestinationBody;
-}
+export interface GetLocationGroupDeliverydestinationRequest
+  extends GetLocationGroupDeliverydestinationPath {}
 
-// DELETE /location/group/{id}/deliverydestination - Delete single or multiple delivery destinations
+// PATCH /location/group/{id}/deliverydestination/{delivery_destination} - Patch a delivery destination
 
-export interface DeleteLocationGroupDeliverydestinationPath {
+export interface PatchLocationGroupDeliverydestinationPath {
   // Group ID
   id: string;
+  // Delivery Destination ID
+  delivery_destination: string;
 }
 
-export interface DeleteLocationGroupDeliverydestinationBody {
-  delivery_destination_ids?: string[];
-}
+export type PatchLocationGroupDeliverydestinationBody = PostOrPatchDeliveryDestination;
 
-export interface DeleteLocationGroupDeliverydestinationResponse {
-  deleted_delivery_destinations?: DeliveryDestination;
-}
+export type PatchLocationGroupDeliverydestinationResponse = DeliveryDestination;
 
-export interface DeleteLocationGroupDeliverydestinationRequest
-  extends DeleteLocationGroupDeliverydestinationPath {
-  body: DeleteLocationGroupDeliverydestinationBody;
+export interface PatchLocationGroupDeliverydestinationRequest
+  extends PatchLocationGroupDeliverydestinationPath {
+  body: PatchLocationGroupDeliverydestinationBody;
 }
 
-// GET /location/group/{id}/deliverydestination/{delivery_destination} - Get a delivery destination
+// DELETE /location/group/{id}/deliverydestination/{delivery_destination} - Delete a delivery destination
 
-export interface GetLocationGroupDeliverydestinationPath {
+export interface DeleteLocationGroupDeliverydestinationPath {
   // Group ID
   id: string;
   // Delivery Destination ID
   delivery_destination: string;
 }
 
-export type GetLocationGroupDeliverydestinationResponse = DeliveryDestination;
+export interface DeleteLocationGroupDeliverydestinationResponse {
+  deleted_delivery_destination?: DeliveryDestination;
+}
 
-export interface GetLocationGroupDeliverydestinationRequest
-  extends GetLocationGroupDeliverydestinationPath {}
+export interface DeleteLocationGroupDeliverydestinationRequest
+  extends DeleteLocationGroupDeliverydestinationPath {}
 
 // GET /location/group/{id}/user/{user_id} - Get a location group info specific to user read permissions
 
@@ -1155,13 +1145,15 @@ export interface PatchLocationSectorRequest
 // POST /location/company - Create a new company
 
 export interface PostLocationCompanyBody {
-  // Sector name
-  name: string;
-  // sector
-  sector: string;
-  label?: any;
-  is?: {
-    global_images_enabled?: boolean;
+  name: {
+    // Sector name
+    name: string;
+    // sector
+    sector: string;
+    label?: any;
+    is?: {
+      global_images_enabled?: boolean;
+    };
   };
 }
 

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

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

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

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

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

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

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

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

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

@@ -1,5 +1,3 @@
-// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
-
 export interface CreateOrder {
   // brand
   location_brand?: string;
@@ -378,12 +376,12 @@ export interface GetOrderCustomerOrdersBrandRequest extends GetOrderCustomerOrde
 
 // GET /order/location/brand/{id} - Get all orders for a location Brand
 
-export interface GetOrderLocationBrandPath {
+export interface GetOrderBrandOrdersPath {
   // The location brand ID
   id: string;
 }
 
-export interface GetOrderLocationBrandQuery {
+export interface GetOrderBrandOrdersQuery {
   // 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.
@@ -400,11 +398,11 @@ export interface GetOrderLocationBrandQuery {
   limit?: number;
 }
 
-export type GetOrderLocationBrandResponse = Orders;
+export type GetOrderBrandOrdersResponse = Orders;
 
-export interface GetOrderLocationBrandRequest
-  extends GetOrderLocationBrandQuery,
-    GetOrderLocationBrandPath {}
+export interface GetOrderBrandOrdersRequest
+  extends GetOrderBrandOrdersQuery,
+    GetOrderBrandOrdersPath {}
 
 // GET /order/location/{id} - Get all orders for a location
 
@@ -452,8 +450,6 @@ 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 {
@@ -463,14 +459,3 @@ 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 {}

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

@@ -1,5 +1,3 @@
-// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
-
 export interface Error {
   message?: string;
   code?: number;
@@ -42,25 +40,14 @@ export interface ShoppingCart {
     _loyalty?: {
       amount?: number;
     };
-    meta?: {
-      // menu id
-      menu?: string;
-      // brand id
-      brand?: string;
-      [index: string]: any;
-    };
+    meta?: any;
     options?: {
-      id?: string;
       label?: {
         en?: string;
       };
-      meta?: any;
       items?: {
         // option
         id?: string;
-        label?: {
-          en?: string;
-        };
         // index
         _index?: string;
         meta?: any;
@@ -302,8 +289,6 @@ export interface LocationGroup {
       brand?: string;
       // location
       location?: string;
-      // location group
-      group?: string;
       // payment
       payment_provider?: string;
       location_description?: string;
@@ -410,252 +395,6 @@ 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;
-  // Store name
-  name?: string;
-  // Full address
-  address?: string;
-  city?: string;
-  state?: string;
-  // Abbreviated address
-  street_address?: string;
-  // ISO code for currency
-  currency_code?: string;
-  latitude?: number;
-  longitude?: number;
-}
-
 export interface CoolrLocations {
   // location
   id?: string;
@@ -675,14 +414,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;
-  // CDL shoppingcart id. If provided, items will be added to this shoppingcart
-  shoppingcart: string;
+  location_brand?: string;
+  // shoppingcart
+  shoppingcart?: string;
 }
 
 export type PostPartnerStandardcognitionShoppingcartResponse = ShoppingCart;
@@ -699,31 +438,6 @@ export interface GetPartnerStandardcognitionLocationsResponse {
 
 export type GetPartnerStandardcognitionLocationsRequest = {};
 
-// GET /partner/standardcognition/stores - Gets the UUID for all the Standard Cognition external locations
-
-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/payment.ts → payment.ts}

@@ -1,5 +1,3 @@
-// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
-
 export interface Transaction {
   success?: boolean;
   [index: string]: any;
@@ -206,8 +204,6 @@ export interface PostPaymentPaymenttokenBody {
   options?: Options;
   // postal or zip code
   postal_code?: string;
-  // flag to determine if the card should be saved or used once
-  use_card_once?: boolean;
 }
 
 export type PostPaymentPaymenttokenResponse = PaymentMethod;

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

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

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

@@ -1,5 +1,3 @@
-// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
-
 export interface Success {
   success?: boolean;
 }

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

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

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

@@ -1,5 +1,3 @@
-// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
-
 export interface Error {
   message?: string;
   code?: number;
@@ -32,25 +30,14 @@ export interface Item {
   _loyalty?: {
     amount?: number;
   };
-  meta?: {
-    // menu id
-    menu?: string;
-    // brand id
-    brand?: string;
-    [index: string]: any;
-  };
+  meta?: any;
   options?: {
-    id?: string;
     label?: {
       en?: string;
     };
-    meta?: any;
     items?: {
       // option
       id?: string;
-      label?: {
-        en?: string;
-      };
       // index
       _index?: string;
       meta?: any;

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

@@ -1,5 +1,3 @@
-// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
-
 export interface location {
   // Location ID
   location_id: string;