@compassdigital/sdk.typescript 3.44.2 → 3.45.0

package/src/interface/shoppingcart.ts

@@ -74,6 +74,8 @@ export interface ItemResponse {
   added_on?: string;
   meal_value?: IntegerValue;
   category?: Label;
+  tax_rate?: MonetaryValue;
+  label?: Label;
 }
 
 export interface ModifierGroupRequest {
@@ -149,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;
 }
 
@@ -238,6 +250,7 @@ export interface ShoppingCartResponse {
     percent_off?: MonetaryValue;
     amount?: MonetaryValue;
     app?: string;
+    discount?: any;
   };
   //@deprecated
   loyalty?: {
@@ -255,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;
@@ -324,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;
@@ -460,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 {
@@ -482,15 +556,23 @@ export interface PostShoppingcartCloneCartPath {
   id: string;
 }
 
+export interface PostShoppingcartCloneCartQuery {
+  // If set to true then all validations will be skipped, requires global write permission
+  skip_validation?: boolean;
+}
+
 export interface PostShoppingcartCloneCartBody {
   menu?: string;
   order_type?: string;
+  // Array of item indexes that should be cloned
+  items_to_clone?: string[];
 }
 
 export type PostShoppingcartCloneCartResponse = ShoppingCartResponse;
 
 export interface PostShoppingcartCloneCartRequest
   extends BaseRequest,
+    RequestQuery<PostShoppingcartCloneCartQuery>,
     PostShoppingcartCloneCartPath {
   body: PostShoppingcartCloneCartBody;
 }