@compassdigital/sdk.typescript 3.44.3 → 3.45.0

package/src/interface/menu.ts

@@ -17,11 +17,31 @@ export interface ItemsListResponse {
   results?: LocalItem[];
 }
 
+export interface MenuV2ListResponse {
+  meta?: Meta;
+  results?: MenuV2[];
+}
+
+export interface LayoutListResponse {
+  meta?: Meta;
+  results?: Layout[];
+}
+
+export interface CategoryListResponse {
+  meta?: Meta;
+  results?: Category[];
+}
+
 export interface ItemToModifierGroupRelationshipListResponse {
   meta?: Meta;
   results?: ItemToModifierGroupRelationship[];
 }
 
+export interface CategoryToItemRelationshipListResponse {
+  meta?: Meta;
+  results?: CategoryToItemRelationship[];
+}
+
 export interface ModifierGroupToModifierRelationshipListResponse {
   meta?: Meta;
   results?: ModifierGroupToModifierRelationship[];
@@ -87,6 +107,36 @@ export interface LocalItem {
   [index: string]: any;
 }
 
+export interface MenuV2 {
+  id?: string;
+  name?: string;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  [index: string]: any;
+}
+
+export interface Layout {
+  id?: string;
+  name?: string;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  [index: string]: any;
+}
+
+export interface Category {
+  id?: string;
+  name?: string;
+  label?: string;
+  sequence?: number;
+  is_active?: boolean;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  [index: string]: any;
+}
+
 export interface ItemToModifierGroupRelationship {
   id?: string;
   item?: Item;
@@ -100,6 +150,19 @@ export interface ItemToModifierGroupRelationship {
   [index: string]: any;
 }
 
+export interface CategoryToItemRelationship {
+  id?: string;
+  item?: Item;
+  item_id?: string;
+  category?: Category;
+  category_id?: string;
+  sequence?: number;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  [index: string]: any;
+}
+
 export interface ModifierGroupToModifierRelationship {
   id?: string;
   modifier?: Modifier;
@@ -731,6 +794,293 @@ export interface DeleteMenuV2ItemRelationshipsModifierGroupRequest
   extends BaseRequest,
     DeleteMenuV2ItemRelationshipsModifierGroupPath {}
 
+// GET /menu/v2/menus
+
+export interface GetMenuV2MenusQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2MenusResponse = MenuV2ListResponse;
+
+export interface GetMenuV2MenusRequest extends BaseRequest, RequestQuery<GetMenuV2MenusQuery> {}
+
+// GET /menu/v2/menu/{id}
+
+export interface GetMenuV2MenuPath {
+  id: string;
+}
+
+export interface GetMenuV2MenuQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2MenuResponse = MenuV2;
+
+export interface GetMenuV2MenuRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2MenuQuery>,
+    GetMenuV2MenuPath {}
+
+// PATCH /menu/v2/menu/{id}
+
+export interface PatchMenuV2MenuPath {
+  id: string;
+}
+
+export type PatchMenuV2MenuBody = MenuV2;
+
+export type PatchMenuV2MenuResponse = MenuV2;
+
+export interface PatchMenuV2MenuRequest extends BaseRequest, PatchMenuV2MenuPath {
+  body: PatchMenuV2MenuBody;
+}
+
+// DELETE /menu/v2/menu/{id}
+
+export interface DeleteMenuV2MenuPath {
+  id: string;
+}
+
+export type DeleteMenuV2MenuResponse = MenuV2;
+
+export interface DeleteMenuV2MenuRequest extends BaseRequest, DeleteMenuV2MenuPath {}
+
+// POST /menu/v2/menu
+
+export type PostMenuV2MenuBody = MenuV2;
+
+export type PostMenuV2MenuResponse = MenuV2;
+
+export interface PostMenuV2MenuRequest extends BaseRequest {
+  body: PostMenuV2MenuBody;
+}
+
+// GET /menu/v2/menus/count
+
+export interface GetMenuV2MenusCountQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export interface GetMenuV2MenusCountResponse {
+  count?: number;
+}
+
+export interface GetMenuV2MenusCountRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2MenusCountQuery> {}
+
+// GET /menu/v2/layouts
+
+export interface GetMenuV2LayoutsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2LayoutsResponse = LayoutListResponse;
+
+export interface GetMenuV2LayoutsRequest extends BaseRequest, RequestQuery<GetMenuV2LayoutsQuery> {}
+
+// GET /menu/v2/layout/{id}
+
+export interface GetMenuV2LayoutPath {
+  id: string;
+}
+
+export interface GetMenuV2LayoutQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2LayoutResponse = Layout;
+
+export interface GetMenuV2LayoutRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2LayoutQuery>,
+    GetMenuV2LayoutPath {}
+
+// PATCH /menu/v2/layout/{id}
+
+export interface PatchMenuV2LayoutPath {
+  id: string;
+}
+
+export type PatchMenuV2LayoutBody = Layout;
+
+export type PatchMenuV2LayoutResponse = Layout;
+
+export interface PatchMenuV2LayoutRequest extends BaseRequest, PatchMenuV2LayoutPath {
+  body: PatchMenuV2LayoutBody;
+}
+
+// DELETE /menu/v2/layout/{id}
+
+export interface DeleteMenuV2LayoutPath {
+  id: string;
+}
+
+export type DeleteMenuV2LayoutResponse = Layout;
+
+export interface DeleteMenuV2LayoutRequest extends BaseRequest, DeleteMenuV2LayoutPath {}
+
+// POST /menu/v2/layout
+
+export type PostMenuV2LayoutBody = Layout;
+
+export type PostMenuV2LayoutResponse = Layout;
+
+export interface PostMenuV2LayoutRequest extends BaseRequest {
+  body: PostMenuV2LayoutBody;
+}
+
+// GET /menu/v2/layouts/count
+
+export interface GetMenuV2LayoutsCountQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export interface GetMenuV2LayoutsCountResponse {
+  count?: number;
+}
+
+export interface GetMenuV2LayoutsCountRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2LayoutsCountQuery> {}
+
+// GET /menu/v2/categories
+
+export interface GetMenuV2CategoriesQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2CategoriesResponse = CategoryListResponse;
+
+export interface GetMenuV2CategoriesRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2CategoriesQuery> {}
+
+// GET /menu/v2/category/{id}
+
+export interface GetMenuV2CategoryPath {
+  id: string;
+}
+
+export interface GetMenuV2CategoryQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2CategoryResponse = Category;
+
+export interface GetMenuV2CategoryRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2CategoryQuery>,
+    GetMenuV2CategoryPath {}
+
+// PATCH /menu/v2/category/{id}
+
+export interface PatchMenuV2CategoryPath {
+  id: string;
+}
+
+export type PatchMenuV2CategoryBody = Category;
+
+export type PatchMenuV2CategoryResponse = Category;
+
+export interface PatchMenuV2CategoryRequest extends BaseRequest, PatchMenuV2CategoryPath {
+  body: PatchMenuV2CategoryBody;
+}
+
+// DELETE /menu/v2/category/{id}
+
+export interface DeleteMenuV2CategoryPath {
+  id: string;
+}
+
+export type DeleteMenuV2CategoryResponse = Category;
+
+export interface DeleteMenuV2CategoryRequest extends BaseRequest, DeleteMenuV2CategoryPath {}
+
+// POST /menu/v2/category
+
+export type PostMenuV2CategoryBody = Category;
+
+export type PostMenuV2CategoryResponse = Category;
+
+export interface PostMenuV2CategoryRequest extends BaseRequest {
+  body: PostMenuV2CategoryBody;
+}
+
+// GET /menu/v2/categories/count
+
+export interface GetMenuV2CategoriesCountQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export interface GetMenuV2CategoriesCountResponse {
+  count?: number;
+}
+
+export interface GetMenuV2CategoriesCountRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2CategoriesCountQuery> {}
+
+// GET /menu/v2/category/relationships/items
+
+export interface GetMenuV2CategoryRelationshipsItemsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2CategoryRelationshipsItemsResponse = CategoryToItemRelationshipListResponse;
+
+export interface GetMenuV2CategoryRelationshipsItemsRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2CategoryRelationshipsItemsQuery> {}
+
+// POST /menu/v2/category/relationships/item
+
+export type PostMenuV2CategoryRelationshipsItemBody = CategoryToItemRelationship;
+
+export type PostMenuV2CategoryRelationshipsItemResponse = CategoryToItemRelationship;
+
+export interface PostMenuV2CategoryRelationshipsItemRequest extends BaseRequest {
+  body: PostMenuV2CategoryRelationshipsItemBody;
+}
+
+// PATCH /menu/v2/category/relationships/item/{id}
+
+export interface PatchMenuV2CategoryRelationshipsItemPath {
+  id: string;
+}
+
+export type PatchMenuV2CategoryRelationshipsItemBody = CategoryToItemRelationship;
+
+export type PatchMenuV2CategoryRelationshipsItemResponse = CategoryToItemRelationship;
+
+export interface PatchMenuV2CategoryRelationshipsItemRequest
+  extends BaseRequest,
+    PatchMenuV2CategoryRelationshipsItemPath {
+  body: PatchMenuV2CategoryRelationshipsItemBody;
+}
+
+// DELETE /menu/v2/category/relationships/item/{id}
+
+export interface DeleteMenuV2CategoryRelationshipsItemPath {
+  id: string;
+}
+
+export type DeleteMenuV2CategoryRelationshipsItemResponse = CategoryToItemRelationship;
+
+export interface DeleteMenuV2CategoryRelationshipsItemRequest
+  extends BaseRequest,
+    DeleteMenuV2CategoryRelationshipsItemPath {}
+
 // GET /menu/client/{client_id} - Get menu client
 
 export interface GetMenuClientPath {

package/src/interface/partner.ts

@@ -186,6 +186,7 @@ export interface ItemResponse {
   added_on?: string;
   meal_value?: IntegerValue;
   category?: Label;
+  tax_rate?: MonetaryValue;
 }
 
 export type MonetaryValue = number;
@@ -742,22 +743,10 @@ export interface CognitionStore {
   longitude?: number;
 }
 
-export interface CoolrLocations {
-  // location
-  id?: string;
-  name?: string;
-  code?: string;
-  timezone?: string;
-  address?: string;
-  date?: {
-    created?: string;
-    modified?: string;
-  };
-  [index: string]: any;
+export interface Success {
+  success?: boolean;
 }
 
-export type CoolrImages = any[];
-
 // POST /partner/standardcognition/shoppingcart - Calculates a shoppingcart
 
 export interface PostPartnerStandardcognitionShoppingcartBody {
@@ -828,6 +817,21 @@ export interface PostPartnerStandardcognitionMenuRequest extends BaseRequest {
   body: PostPartnerStandardcognitionMenuBody;
 }
 
+// POST /partner/event/{id} - Send an event from 3rd party to our system
+
+export interface PostPartnerEventPath {
+  // provider
+  id: string;
+}
+
+export type PostPartnerEventBody = any;
+
+export type PostPartnerEventResponse = Success;
+
+export interface PostPartnerEventRequest extends BaseRequest, PostPartnerEventPath {
+  body: PostPartnerEventBody;
+}
+
 // GET /partner/swagger.json
 
 export interface GetPartnerSwaggerQuery {

package/src/interface/shoppingcart.ts

@@ -75,6 +75,7 @@ export interface ItemResponse {
   meal_value?: IntegerValue;
   category?: Label;
   tax_rate?: MonetaryValue;
+  label?: Label;
 }
 
 export interface ModifierGroupRequest {
@@ -150,35 +151,45 @@ export interface BadgePay {
   name?: string;
 }
 
+export interface Mealplan {
+  id?: string;
+  tender?: string;
+  total?: MonetaryValue;
+}
+
+export interface CreditCard {
+  card_type?: string;
+  last4?: string;
+  total?: MonetaryValue;
+}
+
+export interface DigitalWalletPay {
+  wallet_type?: string;
+  total?: MonetaryValue;
+}
+
+export interface MealSwipes {
+  id?: string;
+  tender?: string;
+  tender_type?: string;
+  tender_name?: string;
+  swipes?: MonetaryValue;
+  rate?: MonetaryValue;
+  total?: MonetaryValue;
+}
+
+export interface MealExchange {
+  id?: string;
+  tender?: string;
+}
+
 export interface Payment {
   email?: string;
-  mealplan?: {
-    id?: string;
-    tender?: string;
-    total?: MonetaryValue;
-  };
-  credit_card?: {
-    card_type?: string;
-    last4?: string;
-    total?: MonetaryValue;
-  };
-  digital_wallet_pay?: {
-    wallet_type?: string;
-    total?: MonetaryValue;
-  };
-  meal_swipes?: {
-    id?: string;
-    tender?: string;
-    tender_type?: string;
-    tender_name?: string;
-    swipes?: MonetaryValue;
-    rate?: MonetaryValue;
-    total?: MonetaryValue;
-  };
-  meal_exchange?: {
-    id?: string;
-    tender?: string;
-  };
+  mealplan?: Mealplan;
+  credit_card?: CreditCard;
+  digital_wallet_pay?: DigitalWalletPay;
+  meal_swipes?: MealSwipes;
+  meal_exchange?: MealExchange;
   badge_pay?: BadgePay;
 }
 
@@ -239,6 +250,7 @@ export interface ShoppingCartResponse {
     percent_off?: MonetaryValue;
     amount?: MonetaryValue;
     app?: string;
+    discount?: any;
   };
   //@deprecated
   loyalty?: {
@@ -256,36 +268,15 @@ export interface ShoppingCartResponse {
     amount_off?: MonetaryValue;
     percent_off?: MonetaryValue;
     amount?: MonetaryValue;
+    discount?: any;
   };
   payment_method?: {
     email?: string;
-    mealplan?: {
-      id?: string;
-      tender?: string;
-      total?: MonetaryValue;
-    };
-    credit_card?: {
-      card_type?: string;
-      last4?: string;
-      total?: MonetaryValue;
-    };
-    digital_wallet_pay?: {
-      wallet_type?: string;
-      total?: MonetaryValue;
-    };
-    meal_swipes?: {
-      id?: string;
-      tender?: string;
-      tender_type?: string;
-      tender_name?: string;
-      swipes?: MonetaryValue;
-      rate?: MonetaryValue;
-      total?: MonetaryValue;
-    };
-    meal_exchange?: {
-      id?: string;
-      tender?: string;
-    };
+    mealplan?: Mealplan;
+    credit_card?: CreditCard;
+    digital_wallet_pay?: DigitalWalletPay;
+    meal_swipes?: MealSwipes;
+    meal_exchange?: MealExchange;
     badge_pay?: BadgePay;
   };
   taxes?: Taxes;
@@ -325,6 +316,69 @@ export interface ShoppingCartResponse {
 
 export type ShoppingCart = ShoppingCartResponse;
 
+export interface PaymentMethods {
+  mealplan: {
+    tenders: Tender[];
+  };
+  badge_pay: {
+    tenders: {
+      balance?: MonetaryValue;
+      id: string;
+      // name associated with badgepay tender, stored in site public config
+      name?: string;
+      is: {
+        eligible: boolean;
+      };
+    }[];
+  };
+  credit_cards: {
+    data: {
+      billing_address?: {
+        postal_code?: string;
+      };
+      card_type?: string;
+      expiry?: {
+        month?: number;
+        year?: number;
+      };
+      is: {
+        eligible: boolean;
+        preferred?: boolean;
+      };
+      masked_card_number?: string;
+      name_on_card?: string;
+      nickname?: string;
+      token: string;
+      token_expiration_date?: string;
+    }[];
+  };
+  digital_wallet_pay: {
+    applewallet: {
+      is: {
+        eligible: boolean;
+      };
+    };
+    googlewallet: {
+      is: {
+        eligible: boolean;
+      };
+    };
+  };
+}
+
+export interface Tender {
+  // tender
+  id: string;
+  name?: string;
+  balance?: MonetaryValue;
+  type: string;
+  is: {
+    eligible: boolean;
+    validated?: boolean;
+  };
+  currency?: string;
+}
+
 export interface Label {
   en?: string;
   fr?: string;
@@ -461,6 +515,25 @@ export interface PutShoppingcartCartPaymentRequest
   body: PutShoppingcartCartPaymentBody;
 }
 
+// GET /shoppingcart/{id}/paymentmethods - Get a list of payment methods for cart
+
+export interface GetShoppingcartPaymentMethodsPath {
+  // Shopping cart ID
+  id: string;
+}
+
+export interface GetShoppingcartPaymentMethodsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetShoppingcartPaymentMethodsResponse = PaymentMethods;
+
+export interface GetShoppingcartPaymentMethodsRequest
+  extends BaseRequest,
+    RequestQuery<GetShoppingcartPaymentMethodsQuery>,
+    GetShoppingcartPaymentMethodsPath {}
+
 // PUT /shoppingcart/{id}/order/ - Store information about the order created with this shopping cart
 
 export interface PutShoppingcartCartOrderPath {