@gofynd/fdk-client-javascript 1.6.4 → 3.1.0-beta.1

package/sdk/platform/Cart/CartPlatformApplicationValidator.js

@@ -9,9 +9,9 @@ const CartPlatformModel = require("./CartPlatformModel");
 
 /**
  * @typedef AddItemsParam
- * @property {string} cartId - Current Cart id of user cart
+ * @property {string} cartId - Current Cart _id
  * @property {boolean} [b]
- * @property {CartPlatformModel.AddCartCreation} body
+ * @property {CartPlatformModel.AddCartRequest} body
  */
 
 /**
@@ -26,12 +26,12 @@ const CartPlatformModel = require("./CartPlatformModel");
  * @property {boolean} [p]
  * @property {string} [id]
  * @property {boolean} [buyNow]
- * @property {CartPlatformModel.ApplyCouponDetails} body
+ * @property {CartPlatformModel.ApplyCouponRequest} body
  */
 
 /**
  * @typedef CheckCartServiceabilityParam
- * @property {CartPlatformModel.OpenApiCartServiceabilityCreation} body
+ * @property {CartPlatformModel.OpenApiCartServiceabilityRequest} body
  */
 
 /**
@@ -57,26 +57,21 @@ const CartPlatformModel = require("./CartPlatformModel");
 /**
  * @typedef DeleteCartParam
  * @property {string} [id] - The unique identifier of the cart.
- * @property {CartPlatformModel.DeleteCartDetails} body
- */
-
-/**
- * @typedef DeleteCouponParam
- * @property {string} id
+ * @property {string} [cartType] - The type of cart
+ * @property {CartPlatformModel.DeleteCartRequest} body
  */
 
 /**
- * @typedef DeletePromotionParam
- * @property {string} id
+ * @typedef DeleteCartMetaConfigParam
+ * @property {string} cartMetaId - CartMeta mongo _id for fetching single cart
+ *   meta data for editing
  */
 
 /**
  * @typedef FetchAndvalidateCartItemsParam
- * @property {CartPlatformModel.OpenapiCartDetailsCreation} body
+ * @property {CartPlatformModel.OpenapiCartDetailsRequest} body
  */
 
-/** @typedef FetchCartMetaConfigParam */
-
 /**
  * @typedef GetAbandonedCartParam
  * @property {number} [pageNo]
@@ -137,9 +132,6 @@ const CartPlatformModel = require("./CartPlatformModel");
  * @typedef GetCartParam
  * @property {string} [id] - The unique identifier of the cart
  * @property {string} [userId] - Option to fetch cart for the provided user_id.
- * @property {string} [orderType] - The order type of shipment HomeDelivery - If
- *   the customer wants the order home-delivered PickAtStore - If the customer
- *   wants the handover of an order at the store itself.
  * @property {boolean} [i] - This is a boolean value. Select `true` to retrieve
  *   all the items added in the cart.
  * @property {boolean} [b] - This is a boolean value. Select `true` to retrieve
@@ -147,6 +139,7 @@ const CartPlatformModel = require("./CartPlatformModel");
  * @property {number} [assignCardId] - Token of user's debit or credit card
  * @property {boolean} [buyNow] - This is a boolen value. Select `true` to
  *   set/initialize buy now cart
+ * @property {string} [cartType] - The type of cart
  */
 
 /**
@@ -156,9 +149,17 @@ const CartPlatformModel = require("./CartPlatformModel");
  * @property {string} [filterOn]
  */
 
+/**
+ * @typedef GetCartMetaConfigParam
+ * @property {string} cartMetaId - CartMeta mongo _id for fetching single cart
+ *   meta data for editing
+ */
+
+/** @typedef GetCartMetaConfigsParam */
+
 /**
  * @typedef GetCartShareLinkParam
- * @property {CartPlatformModel.GetShareCartLinkCreation} body
+ * @property {CartPlatformModel.GetShareCartLinkRequest} body
  */
 
 /**
@@ -178,6 +179,8 @@ const CartPlatformModel = require("./CartPlatformModel");
 
 /** @typedef GetCouponOptionValuesParam */
 
+/** @typedef GetCouponTagsParam */
+
 /**
  * @typedef GetCouponsParam
  * @property {number} [pageNo]
@@ -188,30 +191,24 @@ const CartPlatformModel = require("./CartPlatformModel");
  * @property {boolean} [isDisplay]
  * @property {string} [typeSlug]
  * @property {string} [code]
- * @property {string} [createdBy]
- * @property {string} [reviewedBy]
- * @property {string} [approvedStartTime]
- * @property {string} [approvedEndTime]
- * @property {string} [reviewStartTime]
- * @property {string} [reviewEndTime]
- * @property {string} [status]
  */
 
 /**
  * @typedef GetItemCountParam
  * @property {string} [id] - The unique identifier of the cart.
  * @property {boolean} [buyNow] - Boolean value to get buy_now cart.
+ * @property {string} [cartType] - The type of cart
  */
 
 /**
  * @typedef GetPriceAdjustmentsParam
- * @property {string} cartId - Cart id of user cart
+ * @property {string} cartId - Cart Id
  */
 
 /**
  * @typedef GetPromosCouponConfigParam
- * @property {string} [entityType] - Entity type as promotion or coupon
- * @property {boolean} [isHidden] - Promotion coupon config shown or not
+ * @property {string} [entityType] - Entity_type as promotion or coupon
+ * @property {boolean} [isHidden] - Promo-coupon config shown or not
  */
 
 /**
@@ -224,22 +221,7 @@ const CartPlatformModel = require("./CartPlatformModel");
  * @property {string} [code]
  */
 
-/**
- * @typedef GetPromotionOffersParam
- * @property {string} [slug] - A short, human-readable, URL-friendly identifier
- *   of a product. You can get slug value from the endpoint
- *   /service/application/catalog/v1.0/products/
- * @property {number} [pageSize] - Number of offers to be fetched to show
- * @property {string} [promotionGroup] - Type of promotion groups
- * @property {number} [storeId] - Unique identifier of a store
- * @property {string} [cartType] - The type of cart
- */
-
-/**
- * @typedef GetPromotionPaymentOffersParam
- * @property {string} [id] - Cart id of the user cart
- * @property {number} [uid] - Cart uid of the user cart
- */
+/** @typedef GetPromotionTagsParam */
 
 /**
  * @typedef GetPromotionsParam
@@ -251,13 +233,6 @@ const CartPlatformModel = require("./CartPlatformModel");
  * @property {string} [promotionType]
  * @property {string} [fpPanel]
  * @property {string} [promotionId]
- * @property {string} [createdBy]
- * @property {string} [reviewedBy]
- * @property {string} [approvedStartTime]
- * @property {string} [approvedEndTime]
- * @property {string} [reviewStartTime]
- * @property {string} [reviewEndTime]
- * @property {string} [status]
  */
 
 /**
@@ -294,23 +269,23 @@ const CartPlatformModel = require("./CartPlatformModel");
  *   the price breakup of cart items.
  * @property {boolean} [buyNow] - This is a boolen value. Select `true` to
  *   set/initialize buy now cart
- * @property {string} [orderType] - The order type of shipment HomeDelivery - If
- *   the customer wants the order home-delivered PickAtStore - If the customer
- *   wants the handover of an order at the store itself.
  * @property {string} [id] - The unique identifier of the cart
- * @property {CartPlatformModel.PlatformAddCartDetails} body
+ * @property {string} [cartType] - The type of cart
+ * @property {CartPlatformModel.PlatformAddCartRequest} body
  */
 
 /**
  * @typedef PlatformCheckoutCartParam
  * @property {string} [id] - The unique identifier of the cart
- * @property {CartPlatformModel.PlatformCartCheckoutDetailCreation} body
+ * @property {string} [cartType] - The type of cart
+ * @property {CartPlatformModel.PlatformCartCheckoutDetailRequest} body
  */
 
 /**
  * @typedef PlatformCheckoutCartV2Param
  * @property {string} [id] - The unique identifier of the cart
- * @property {CartPlatformModel.PlatformCartCheckoutDetailV2Creation} body
+ * @property {string} [cartType] - The type of cart
+ * @property {CartPlatformModel.PlatformCartCheckoutDetailV2Request} body
  */
 
 /**
@@ -325,7 +300,8 @@ const CartPlatformModel = require("./CartPlatformModel");
  *   the price breakup of cart items.
  * @property {boolean} [buyNow] - This is a boolen value. Select `true` to
  *   set/initialize buy now cart
- * @property {CartPlatformModel.PlatformUpdateCartDetails} body
+ * @property {string} [cartType] - The type of cart
+ * @property {CartPlatformModel.PlatformUpdateCartRequest} body
  */
 
 /**
@@ -338,6 +314,7 @@ const CartPlatformModel = require("./CartPlatformModel");
  * @typedef RemoveCouponParam
  * @property {string} [uid]
  * @property {boolean} [buyNow]
+ * @property {string} [cartType] - The type of cart
  */
 
 /**
@@ -351,22 +328,26 @@ const CartPlatformModel = require("./CartPlatformModel");
  * @property {boolean} [buyNow]
  * @property {boolean} [i]
  * @property {boolean} [b]
- * @property {CartPlatformModel.PlatformSelectCartAddress} body
+ * @property {CartPlatformModel.PlatformSelectCartAddressRequest} body
  */
 
 /**
  * @typedef SelectPaymentModeParam
  * @property {string} [id]
  * @property {boolean} [buyNow]
- * @property {string} [orderType]
- * @property {CartPlatformModel.CartPaymentUpdate} body
+ * @property {string} [orderType] - The order type of shipment HomeDelivery - If
+ *   the customer wants the order home-delivered PickAtStore - If the customer
+ *   wants the handover of an order at the store itself.
+ * @property {CartPlatformModel.UpdateCartPaymentRequest} body
  */
 
 /**
  * @typedef SelectPaymentModeV2Param
  * @property {string} [id]
  * @property {boolean} [buyNow]
- * @property {string} [orderType]
+ * @property {string} [orderType] - The order type of shipment HomeDelivery - If
+ *   the customer wants the order home-delivered PickAtStore - If the customer
+ *   wants the handover of an order at the store itself.
  * @property {CartPlatformModel.UpdateCartPaymentRequestV2} body
  */
 
@@ -378,22 +359,23 @@ const CartPlatformModel = require("./CartPlatformModel");
 
 /**
  * @typedef UpdateCartParam
- * @property {string} cartId - Current Cart id of user cart
+ * @property {string} cartId - Current Cart _id
  * @property {boolean} [b]
- * @property {CartPlatformModel.UpdateCartCreation} body
+ * @property {CartPlatformModel.UpdateCartRequest} body
  */
 
 /**
  * @typedef UpdateCartMetaParam
  * @property {string} [id]
  * @property {boolean} [buyNow]
- * @property {CartPlatformModel.PlatformCartMetaCreation} body
+ * @property {string} [userId]
+ * @property {CartPlatformModel.PlatformCartMetaRequest} body
  */
 
 /**
  * @typedef UpdateCartMetaConfigParam
- * @property {string} cartMetaId - CartMeta id for fetching single cart meta
- *   data for editing
+ * @property {string} cartMetaId - CartMeta mongo _id for fetching single cart
+ *   meta data for editing
  * @property {CartPlatformModel.CartMetaConfigUpdate} body
  */
 
@@ -452,7 +434,7 @@ const CartPlatformModel = require("./CartPlatformModel");
  * @property {string} [orderType] - The order type of shipment HomeDelivery - If
  *   the customer wants the order home-delivered PickAtStore - If the customer
  *   wants the handover of an order at the store itself.
- * @property {CartPlatformModel.UpdateCartShipmentCreation} body
+ * @property {CartPlatformModel.UpdateCartShipmentRequest} body
  */
 
 /**
@@ -464,6 +446,11 @@ const CartPlatformModel = require("./CartPlatformModel");
  * @property {string} [paymentIdentifier]
  * @property {string} [aggregatorName]
  * @property {string} [merchantCode]
+ * @property {string} [iin] - Debit/Credit card prefix (first 6 digit)
+ * @property {string} [network] - Credit/Debit card issuer, e.g. VISA, MASTERCARD, RUPAY
+ * @property {string} [type] - Card type, e.g. Credit, Debit
+ * @property {string} [cardId] - Saved card token reference id
+ * @property {string} [cartType] - Type of the cart
  */
 
 class CartPlatformApplicationValidator {
@@ -479,7 +466,7 @@ class CartPlatformApplicationValidator {
     return Joi.object({
       cartId: Joi.string().allow("").required(),
       b: Joi.boolean(),
-      body: CartPlatformModel.AddCartCreation().required(),
+      body: CartPlatformModel.AddCartRequest().required(),
     }).required();
   }
 
@@ -498,14 +485,14 @@ class CartPlatformApplicationValidator {
       p: Joi.boolean(),
       id: Joi.string().allow(""),
       buyNow: Joi.boolean(),
-      body: CartPlatformModel.ApplyCouponDetails().required(),
+      body: CartPlatformModel.ApplyCouponRequest().required(),
     }).required();
   }
 
   /** @returns {CheckCartServiceabilityParam} */
   static checkCartServiceability() {
     return Joi.object({
-      body: CartPlatformModel.OpenApiCartServiceabilityCreation().required(),
+      body: CartPlatformModel.OpenApiCartServiceabilityRequest().required(),
     }).required();
   }
 
@@ -541,36 +528,25 @@ class CartPlatformApplicationValidator {
   static deleteCart() {
     return Joi.object({
       id: Joi.string().allow(""),
-      body: CartPlatformModel.DeleteCartDetails().required(),
-    }).required();
-  }
-
-  /** @returns {DeleteCouponParam} */
-  static deleteCoupon() {
-    return Joi.object({
-      id: Joi.string().allow("").required(),
+      cartType: Joi.string().allow(""),
+      body: CartPlatformModel.DeleteCartRequest().required(),
     }).required();
   }
 
-  /** @returns {DeletePromotionParam} */
-  static deletePromotion() {
+  /** @returns {DeleteCartMetaConfigParam} */
+  static deleteCartMetaConfig() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
+      cartMetaId: Joi.string().allow("").required(),
     }).required();
   }
 
   /** @returns {FetchAndvalidateCartItemsParam} */
   static fetchAndvalidateCartItems() {
     return Joi.object({
-      body: CartPlatformModel.OpenapiCartDetailsCreation().required(),
+      body: CartPlatformModel.OpenapiCartDetailsRequest().required(),
     }).required();
   }
 
-  /** @returns {FetchCartMetaConfigParam} */
-  static fetchCartMetaConfig() {
-    return Joi.object({}).required();
-  }
-
   /** @returns {GetAbandonedCartParam} */
   static getAbandonedCart() {
     return Joi.object({
@@ -644,11 +620,11 @@ class CartPlatformApplicationValidator {
     return Joi.object({
       id: Joi.string().allow(""),
       userId: Joi.string().allow(""),
-      orderType: Joi.string().allow(""),
       i: Joi.boolean(),
       b: Joi.boolean(),
       assignCardId: Joi.number(),
       buyNow: Joi.boolean(),
+      cartType: Joi.string().allow(""),
     }).required();
   }
 
@@ -661,10 +637,22 @@ class CartPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {GetCartMetaConfigParam} */
+  static getCartMetaConfig() {
+    return Joi.object({
+      cartMetaId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetCartMetaConfigsParam} */
+  static getCartMetaConfigs() {
+    return Joi.object({}).required();
+  }
+
   /** @returns {GetCartShareLinkParam} */
   static getCartShareLink() {
     return Joi.object({
-      body: CartPlatformModel.GetShareCartLinkCreation().required(),
+      body: CartPlatformModel.GetShareCartLinkRequest().required(),
     }).required();
   }
 
@@ -694,6 +682,11 @@ class CartPlatformApplicationValidator {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetCouponTagsParam} */
+  static getCouponTags() {
+    return Joi.object({}).required();
+  }
+
   /** @returns {GetCouponsParam} */
   static getCoupons() {
     return Joi.object({
@@ -705,13 +698,6 @@ class CartPlatformApplicationValidator {
       isDisplay: Joi.boolean(),
       typeSlug: Joi.string().allow(""),
       code: Joi.string().allow(""),
-      createdBy: Joi.string().allow(""),
-      reviewedBy: Joi.string().allow(""),
-      approvedStartTime: Joi.string().allow(""),
-      approvedEndTime: Joi.string().allow(""),
-      reviewStartTime: Joi.string().allow(""),
-      reviewEndTime: Joi.string().allow(""),
-      status: Joi.string().allow(""),
     }).required();
   }
 
@@ -720,6 +706,7 @@ class CartPlatformApplicationValidator {
     return Joi.object({
       id: Joi.string().allow(""),
       buyNow: Joi.boolean(),
+      cartType: Joi.string().allow(""),
     }).required();
   }
 
@@ -752,23 +739,9 @@ class CartPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {GetPromotionOffersParam} */
-  static getPromotionOffers() {
-    return Joi.object({
-      slug: Joi.string().allow(""),
-      pageSize: Joi.number(),
-      promotionGroup: Joi.string().allow(""),
-      storeId: Joi.number(),
-      cartType: Joi.string().allow(""),
-    }).required();
-  }
-
-  /** @returns {GetPromotionPaymentOffersParam} */
-  static getPromotionPaymentOffers() {
-    return Joi.object({
-      id: Joi.string().allow(""),
-      uid: Joi.number(),
-    }).required();
+  /** @returns {GetPromotionTagsParam} */
+  static getPromotionTags() {
+    return Joi.object({}).required();
   }
 
   /** @returns {GetPromotionsParam} */
@@ -782,13 +755,6 @@ class CartPlatformApplicationValidator {
       promotionType: Joi.string().allow(""),
       fpPanel: Joi.string().allow(""),
       promotionId: Joi.string().allow(""),
-      createdBy: Joi.string().allow(""),
-      reviewedBy: Joi.string().allow(""),
-      approvedStartTime: Joi.string().allow(""),
-      approvedEndTime: Joi.string().allow(""),
-      reviewStartTime: Joi.string().allow(""),
-      reviewEndTime: Joi.string().allow(""),
-      status: Joi.string().allow(""),
     }).required();
   }
 
@@ -826,9 +792,9 @@ class CartPlatformApplicationValidator {
       i: Joi.boolean(),
       b: Joi.boolean(),
       buyNow: Joi.boolean(),
-      orderType: Joi.string().allow(""),
       id: Joi.string().allow(""),
-      body: CartPlatformModel.PlatformAddCartDetails().required(),
+      cartType: Joi.string().allow(""),
+      body: CartPlatformModel.PlatformAddCartRequest().required(),
     }).required();
   }
 
@@ -836,7 +802,8 @@ class CartPlatformApplicationValidator {
   static platformCheckoutCart() {
     return Joi.object({
       id: Joi.string().allow(""),
-      body: CartPlatformModel.PlatformCartCheckoutDetailCreation().required(),
+      cartType: Joi.string().allow(""),
+      body: CartPlatformModel.PlatformCartCheckoutDetailRequest().required(),
     }).required();
   }
 
@@ -844,7 +811,8 @@ class CartPlatformApplicationValidator {
   static platformCheckoutCartV2() {
     return Joi.object({
       id: Joi.string().allow(""),
-      body: CartPlatformModel.PlatformCartCheckoutDetailV2Creation().required(),
+      cartType: Joi.string().allow(""),
+      body: CartPlatformModel.PlatformCartCheckoutDetailV2Request().required(),
     }).required();
   }
 
@@ -856,7 +824,8 @@ class CartPlatformApplicationValidator {
       orderType: Joi.string().allow(""),
       b: Joi.boolean(),
       buyNow: Joi.boolean(),
-      body: CartPlatformModel.PlatformUpdateCartDetails().required(),
+      cartType: Joi.string().allow(""),
+      body: CartPlatformModel.PlatformUpdateCartRequest().required(),
     }).required();
   }
 
@@ -873,6 +842,7 @@ class CartPlatformApplicationValidator {
     return Joi.object({
       uid: Joi.string().allow(""),
       buyNow: Joi.boolean(),
+      cartType: Joi.string().allow(""),
     }).required();
   }
 
@@ -890,7 +860,7 @@ class CartPlatformApplicationValidator {
       buyNow: Joi.boolean(),
       i: Joi.boolean(),
       b: Joi.boolean(),
-      body: CartPlatformModel.PlatformSelectCartAddress().required(),
+      body: CartPlatformModel.PlatformSelectCartAddressRequest().required(),
     }).required();
   }
 
@@ -900,7 +870,7 @@ class CartPlatformApplicationValidator {
       id: Joi.string().allow(""),
       buyNow: Joi.boolean(),
       orderType: Joi.string().allow(""),
-      body: CartPlatformModel.CartPaymentUpdate().required(),
+      body: CartPlatformModel.UpdateCartPaymentRequest().required(),
     }).required();
   }
 
@@ -927,7 +897,7 @@ class CartPlatformApplicationValidator {
     return Joi.object({
       cartId: Joi.string().allow("").required(),
       b: Joi.boolean(),
-      body: CartPlatformModel.UpdateCartCreation().required(),
+      body: CartPlatformModel.UpdateCartRequest().required(),
     }).required();
   }
 
@@ -936,7 +906,8 @@ class CartPlatformApplicationValidator {
     return Joi.object({
       id: Joi.string().allow(""),
       buyNow: Joi.boolean(),
-      body: CartPlatformModel.PlatformCartMetaCreation().required(),
+      userId: Joi.string().allow(""),
+      body: CartPlatformModel.PlatformCartMetaRequest().required(),
     }).required();
   }
 
@@ -1014,7 +985,7 @@ class CartPlatformApplicationValidator {
       addressId: Joi.string().allow(""),
       areaCode: Joi.string().allow(""),
       orderType: Joi.string().allow(""),
-      body: CartPlatformModel.UpdateCartShipmentCreation().required(),
+      body: CartPlatformModel.UpdateCartShipmentRequest().required(),
     }).required();
   }
 
@@ -1028,6 +999,11 @@ class CartPlatformApplicationValidator {
       paymentIdentifier: Joi.string().allow(""),
       aggregatorName: Joi.string().allow(""),
       merchantCode: Joi.string().allow(""),
+      iin: Joi.string().allow(""),
+      network: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      cardId: Joi.string().allow(""),
+      cartType: Joi.string().allow(""),
     }).required();
   }
 }