@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.0.0

package/sdk/platform/Cart/CartPlatformApplicationValidator.js

@@ -9,9 +9,9 @@ const CartPlatformModel = require("./CartPlatformModel");
 
 /**
  * @typedef AddItemsParam
- * @property {string} cartId - Current Cart _id
+ * @property {string} cartId - Current Cart id of user cart
  * @property {boolean} [b]
- * @property {CartPlatformModel.AddCartRequest} body
+ * @property {CartPlatformModel.AddCartCreation} body
  */
 
 /**
@@ -26,12 +26,12 @@ const CartPlatformModel = require("./CartPlatformModel");
  * @property {boolean} [p]
  * @property {string} [id]
  * @property {boolean} [buyNow]
- * @property {CartPlatformModel.ApplyCouponRequest} body
+ * @property {CartPlatformModel.ApplyCouponDetails} body
  */
 
 /**
  * @typedef CheckCartServiceabilityParam
- * @property {CartPlatformModel.OpenApiCartServiceabilityRequest} body
+ * @property {CartPlatformModel.OpenApiCartServiceabilityCreation} body
  */
 
 /**
@@ -57,21 +57,26 @@ const CartPlatformModel = require("./CartPlatformModel");
 /**
  * @typedef DeleteCartParam
  * @property {string} [id] - The unique identifier of the cart.
- * @property {string} [cartType] - The type of cart
- * @property {CartPlatformModel.DeleteCartRequest} body
+ * @property {CartPlatformModel.DeleteCartDetails} body
+ */
+
+/**
+ * @typedef DeleteCouponParam
+ * @property {string} id
  */
 
 /**
- * @typedef DeleteCartMetaConfigParam
- * @property {string} cartMetaId - CartMeta mongo _id for fetching single cart
- *   meta data for editing
+ * @typedef DeletePromotionParam
+ * @property {string} id
  */
 
 /**
  * @typedef FetchAndvalidateCartItemsParam
- * @property {CartPlatformModel.OpenapiCartDetailsRequest} body
+ * @property {CartPlatformModel.OpenapiCartDetailsCreation} body
  */
 
+/** @typedef FetchCartMetaConfigParam */
+
 /**
  * @typedef GetAbandonedCartParam
  * @property {number} [pageNo]
@@ -132,6 +137,9 @@ 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
@@ -139,7 +147,6 @@ 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
  */
 
 /**
@@ -149,17 +156,9 @@ 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.GetShareCartLinkRequest} body
+ * @property {CartPlatformModel.GetShareCartLinkCreation} body
  */
 
 /**
@@ -179,8 +178,6 @@ const CartPlatformModel = require("./CartPlatformModel");
 
 /** @typedef GetCouponOptionValuesParam */
 
-/** @typedef GetCouponTagsParam */
-
 /**
  * @typedef GetCouponsParam
  * @property {number} [pageNo]
@@ -191,24 +188,30 @@ 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
+ * @property {string} cartId - Cart id of user cart
  */
 
 /**
  * @typedef GetPromosCouponConfigParam
- * @property {string} [entityType] - Entity_type as promotion or coupon
- * @property {boolean} [isHidden] - Promo-coupon config shown or not
+ * @property {string} [entityType] - Entity type as promotion or coupon
+ * @property {boolean} [isHidden] - Promotion coupon config shown or not
  */
 
 /**
@@ -221,7 +224,22 @@ const CartPlatformModel = require("./CartPlatformModel");
  * @property {string} [code]
  */
 
-/** @typedef GetPromotionTagsParam */
+/**
+ * @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 GetPromotionsParam
@@ -233,6 +251,13 @@ 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]
  */
 
 /**
@@ -269,23 +294,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 {string} [cartType] - The type of cart
- * @property {CartPlatformModel.PlatformAddCartRequest} body
+ * @property {CartPlatformModel.PlatformAddCartDetails} body
  */
 
 /**
  * @typedef PlatformCheckoutCartParam
  * @property {string} [id] - The unique identifier of the cart
- * @property {string} [cartType] - The type of cart
- * @property {CartPlatformModel.PlatformCartCheckoutDetailRequest} body
+ * @property {CartPlatformModel.PlatformCartCheckoutDetailCreation} body
  */
 
 /**
  * @typedef PlatformCheckoutCartV2Param
  * @property {string} [id] - The unique identifier of the cart
- * @property {string} [cartType] - The type of cart
- * @property {CartPlatformModel.PlatformCartCheckoutDetailV2Request} body
+ * @property {CartPlatformModel.PlatformCartCheckoutDetailV2Creation} body
  */
 
 /**
@@ -300,8 +325,7 @@ 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} [cartType] - The type of cart
- * @property {CartPlatformModel.PlatformUpdateCartRequest} body
+ * @property {CartPlatformModel.PlatformUpdateCartDetails} body
  */
 
 /**
@@ -314,7 +338,6 @@ const CartPlatformModel = require("./CartPlatformModel");
  * @typedef RemoveCouponParam
  * @property {string} [uid]
  * @property {boolean} [buyNow]
- * @property {string} [cartType] - The type of cart
  */
 
 /**
@@ -328,26 +351,22 @@ const CartPlatformModel = require("./CartPlatformModel");
  * @property {boolean} [buyNow]
  * @property {boolean} [i]
  * @property {boolean} [b]
- * @property {CartPlatformModel.PlatformSelectCartAddressRequest} body
+ * @property {CartPlatformModel.PlatformSelectCartAddress} body
  */
 
 /**
  * @typedef SelectPaymentModeParam
  * @property {string} [id]
  * @property {boolean} [buyNow]
- * @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
+ * @property {string} [orderType]
+ * @property {CartPlatformModel.CartPaymentUpdate} body
  */
 
 /**
  * @typedef SelectPaymentModeV2Param
  * @property {string} [id]
  * @property {boolean} [buyNow]
- * @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} [orderType]
  * @property {CartPlatformModel.UpdateCartPaymentRequestV2} body
  */
 
@@ -359,23 +378,22 @@ const CartPlatformModel = require("./CartPlatformModel");
 
 /**
  * @typedef UpdateCartParam
- * @property {string} cartId - Current Cart _id
+ * @property {string} cartId - Current Cart id of user cart
  * @property {boolean} [b]
- * @property {CartPlatformModel.UpdateCartRequest} body
+ * @property {CartPlatformModel.UpdateCartCreation} body
  */
 
 /**
  * @typedef UpdateCartMetaParam
  * @property {string} [id]
  * @property {boolean} [buyNow]
- * @property {string} [userId]
- * @property {CartPlatformModel.PlatformCartMetaRequest} body
+ * @property {CartPlatformModel.PlatformCartMetaCreation} body
  */
 
 /**
  * @typedef UpdateCartMetaConfigParam
- * @property {string} cartMetaId - CartMeta mongo _id for fetching single cart
- *   meta data for editing
+ * @property {string} cartMetaId - CartMeta id for fetching single cart meta
+ *   data for editing
  * @property {CartPlatformModel.CartMetaConfigUpdate} body
  */
 
@@ -434,7 +452,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.UpdateCartShipmentRequest} body
+ * @property {CartPlatformModel.UpdateCartShipmentCreation} body
  */
 
 /**
@@ -446,11 +464,6 @@ 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 {
@@ -466,7 +479,7 @@ class CartPlatformApplicationValidator {
     return Joi.object({
       cartId: Joi.string().allow("").required(),
       b: Joi.boolean(),
-      body: CartPlatformModel.AddCartRequest().required(),
+      body: CartPlatformModel.AddCartCreation().required(),
     }).required();
   }
 
@@ -485,14 +498,14 @@ class CartPlatformApplicationValidator {
       p: Joi.boolean(),
       id: Joi.string().allow(""),
       buyNow: Joi.boolean(),
-      body: CartPlatformModel.ApplyCouponRequest().required(),
+      body: CartPlatformModel.ApplyCouponDetails().required(),
     }).required();
   }
 
   /** @returns {CheckCartServiceabilityParam} */
   static checkCartServiceability() {
     return Joi.object({
-      body: CartPlatformModel.OpenApiCartServiceabilityRequest().required(),
+      body: CartPlatformModel.OpenApiCartServiceabilityCreation().required(),
     }).required();
   }
 
@@ -528,25 +541,36 @@ class CartPlatformApplicationValidator {
   static deleteCart() {
     return Joi.object({
       id: Joi.string().allow(""),
-      cartType: Joi.string().allow(""),
-      body: CartPlatformModel.DeleteCartRequest().required(),
+      body: CartPlatformModel.DeleteCartDetails().required(),
     }).required();
   }
 
-  /** @returns {DeleteCartMetaConfigParam} */
-  static deleteCartMetaConfig() {
+  /** @returns {DeleteCouponParam} */
+  static deleteCoupon() {
     return Joi.object({
-      cartMetaId: Joi.string().allow("").required(),
+      id: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {DeletePromotionParam} */
+  static deletePromotion() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
     }).required();
   }
 
   /** @returns {FetchAndvalidateCartItemsParam} */
   static fetchAndvalidateCartItems() {
     return Joi.object({
-      body: CartPlatformModel.OpenapiCartDetailsRequest().required(),
+      body: CartPlatformModel.OpenapiCartDetailsCreation().required(),
     }).required();
   }
 
+  /** @returns {FetchCartMetaConfigParam} */
+  static fetchCartMetaConfig() {
+    return Joi.object({}).required();
+  }
+
   /** @returns {GetAbandonedCartParam} */
   static getAbandonedCart() {
     return Joi.object({
@@ -620,11 +644,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();
   }
 
@@ -637,22 +661,10 @@ 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.GetShareCartLinkRequest().required(),
+      body: CartPlatformModel.GetShareCartLinkCreation().required(),
     }).required();
   }
 
@@ -682,11 +694,6 @@ class CartPlatformApplicationValidator {
     return Joi.object({}).required();
   }
 
-  /** @returns {GetCouponTagsParam} */
-  static getCouponTags() {
-    return Joi.object({}).required();
-  }
-
   /** @returns {GetCouponsParam} */
   static getCoupons() {
     return Joi.object({
@@ -698,6 +705,13 @@ 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();
   }
 
@@ -706,7 +720,6 @@ class CartPlatformApplicationValidator {
     return Joi.object({
       id: Joi.string().allow(""),
       buyNow: Joi.boolean(),
-      cartType: Joi.string().allow(""),
     }).required();
   }
 
@@ -739,9 +752,23 @@ class CartPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {GetPromotionTagsParam} */
-  static getPromotionTags() {
-    return Joi.object({}).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 {GetPromotionsParam} */
@@ -755,6 +782,13 @@ 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();
   }
 
@@ -792,9 +826,9 @@ class CartPlatformApplicationValidator {
       i: Joi.boolean(),
       b: Joi.boolean(),
       buyNow: Joi.boolean(),
+      orderType: Joi.string().allow(""),
       id: Joi.string().allow(""),
-      cartType: Joi.string().allow(""),
-      body: CartPlatformModel.PlatformAddCartRequest().required(),
+      body: CartPlatformModel.PlatformAddCartDetails().required(),
     }).required();
   }
 
@@ -802,8 +836,7 @@ class CartPlatformApplicationValidator {
   static platformCheckoutCart() {
     return Joi.object({
       id: Joi.string().allow(""),
-      cartType: Joi.string().allow(""),
-      body: CartPlatformModel.PlatformCartCheckoutDetailRequest().required(),
+      body: CartPlatformModel.PlatformCartCheckoutDetailCreation().required(),
     }).required();
   }
 
@@ -811,8 +844,7 @@ class CartPlatformApplicationValidator {
   static platformCheckoutCartV2() {
     return Joi.object({
       id: Joi.string().allow(""),
-      cartType: Joi.string().allow(""),
-      body: CartPlatformModel.PlatformCartCheckoutDetailV2Request().required(),
+      body: CartPlatformModel.PlatformCartCheckoutDetailV2Creation().required(),
     }).required();
   }
 
@@ -824,8 +856,7 @@ class CartPlatformApplicationValidator {
       orderType: Joi.string().allow(""),
       b: Joi.boolean(),
       buyNow: Joi.boolean(),
-      cartType: Joi.string().allow(""),
-      body: CartPlatformModel.PlatformUpdateCartRequest().required(),
+      body: CartPlatformModel.PlatformUpdateCartDetails().required(),
     }).required();
   }
 
@@ -842,7 +873,6 @@ class CartPlatformApplicationValidator {
     return Joi.object({
       uid: Joi.string().allow(""),
       buyNow: Joi.boolean(),
-      cartType: Joi.string().allow(""),
     }).required();
   }
 
@@ -860,7 +890,7 @@ class CartPlatformApplicationValidator {
       buyNow: Joi.boolean(),
       i: Joi.boolean(),
       b: Joi.boolean(),
-      body: CartPlatformModel.PlatformSelectCartAddressRequest().required(),
+      body: CartPlatformModel.PlatformSelectCartAddress().required(),
     }).required();
   }
 
@@ -870,7 +900,7 @@ class CartPlatformApplicationValidator {
       id: Joi.string().allow(""),
       buyNow: Joi.boolean(),
       orderType: Joi.string().allow(""),
-      body: CartPlatformModel.UpdateCartPaymentRequest().required(),
+      body: CartPlatformModel.CartPaymentUpdate().required(),
     }).required();
   }
 
@@ -897,7 +927,7 @@ class CartPlatformApplicationValidator {
     return Joi.object({
       cartId: Joi.string().allow("").required(),
       b: Joi.boolean(),
-      body: CartPlatformModel.UpdateCartRequest().required(),
+      body: CartPlatformModel.UpdateCartCreation().required(),
     }).required();
   }
 
@@ -906,8 +936,7 @@ class CartPlatformApplicationValidator {
     return Joi.object({
       id: Joi.string().allow(""),
       buyNow: Joi.boolean(),
-      userId: Joi.string().allow(""),
-      body: CartPlatformModel.PlatformCartMetaRequest().required(),
+      body: CartPlatformModel.PlatformCartMetaCreation().required(),
     }).required();
   }
 
@@ -985,7 +1014,7 @@ class CartPlatformApplicationValidator {
       addressId: Joi.string().allow(""),
       areaCode: Joi.string().allow(""),
       orderType: Joi.string().allow(""),
-      body: CartPlatformModel.UpdateCartShipmentRequest().required(),
+      body: CartPlatformModel.UpdateCartShipmentCreation().required(),
     }).required();
   }
 
@@ -999,11 +1028,6 @@ 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();
   }
 }