@gofynd/fdk-client-javascript 1.4.15-beta.2 → 1.4.15-beta.3

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,12 +57,22 @@ const CartPlatformModel = require("./CartPlatformModel");
 /**
  * @typedef DeleteCartParam
  * @property {string} [id] - The unique identifier of the cart.
- * @property {CartPlatformModel.DeleteCartRequest} body
+ * @property {CartPlatformModel.DeleteCartDetails} body
+ */
+
+/**
+ * @typedef DeleteCouponParam
+ * @property {string} id
+ */
+
+/**
+ * @typedef DeletePromotionParam
+ * @property {string} id
  */
 
 /**
  * @typedef FetchAndvalidateCartItemsParam
- * @property {CartPlatformModel.OpenapiCartDetailsRequest} body
+ * @property {CartPlatformModel.OpenapiCartDetailsCreation} body
  */
 
 /** @typedef FetchCartMetaConfigParam */
@@ -148,7 +158,7 @@ const CartPlatformModel = require("./CartPlatformModel");
 
 /**
  * @typedef GetCartShareLinkParam
- * @property {CartPlatformModel.GetShareCartLinkRequest} body
+ * @property {CartPlatformModel.GetShareCartLinkCreation} body
  */
 
 /**
@@ -178,6 +188,13 @@ 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]
  */
 
 /**
@@ -188,13 +205,13 @@ const CartPlatformModel = require("./CartPlatformModel");
 
 /**
  * @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
  */
 
 /**
@@ -214,14 +231,16 @@ const CartPlatformModel = require("./CartPlatformModel");
  *   /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] - Store id
+ * @property {number} [storeId] - Unique identifier of a store
  * @property {string} [cartType] - The type of cart
+ * @property {string} [sortBy] - Specifies the sorting criteria for the
+ *   promotions. Sorts promotions in descending order by the value provided.
  */
 
 /**
  * @typedef GetPromotionPaymentOffersParam
- * @property {string} [id] - Cart id
- * @property {number} [uid] - Cart uid
+ * @property {string} [id] - Cart id of the user cart
+ * @property {number} [uid] - Cart uid of the user cart
  */
 
 /**
@@ -234,6 +253,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]
  */
 
 /**
@@ -274,13 +300,19 @@ const CartPlatformModel = require("./CartPlatformModel");
  *   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.PlatformAddCartRequest} body
+ * @property {CartPlatformModel.PlatformAddCartDetails} body
+ */
+
+/**
+ * @typedef PlatformCheckoutCartParam
+ * @property {string} [id] - The unique identifier of the cart
+ * @property {CartPlatformModel.PlatformCartCheckoutDetailCreation} body
  */
 
 /**
  * @typedef PlatformCheckoutCartV2Param
  * @property {string} [id] - The unique identifier of the cart
- * @property {CartPlatformModel.PlatformCartCheckoutDetailV2Request} body
+ * @property {CartPlatformModel.PlatformCartCheckoutDetailV2Creation} body
  */
 
 /**
@@ -295,7 +327,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 {CartPlatformModel.PlatformUpdateCartRequest} body
+ * @property {CartPlatformModel.PlatformUpdateCartDetails} body
  */
 
 /**
@@ -321,26 +353,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
  */
 
@@ -352,22 +380,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 {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
  */
 
@@ -426,7 +454,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
  */
 
 /**
@@ -453,7 +481,7 @@ class CartPlatformApplicationValidator {
     return Joi.object({
       cartId: Joi.string().allow("").required(),
       b: Joi.boolean(),
-      body: CartPlatformModel.AddCartRequest().required(),
+      body: CartPlatformModel.AddCartCreation().required(),
     }).required();
   }
 
@@ -472,14 +500,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();
   }
 
@@ -515,14 +543,28 @@ class CartPlatformApplicationValidator {
   static deleteCart() {
     return Joi.object({
       id: Joi.string().allow(""),
-      body: CartPlatformModel.DeleteCartRequest().required(),
+      body: CartPlatformModel.DeleteCartDetails().required(),
+    }).required();
+  }
+
+  /** @returns {DeleteCouponParam} */
+  static deleteCoupon() {
+    return Joi.object({
+      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();
   }
 
@@ -624,7 +666,7 @@ class CartPlatformApplicationValidator {
   /** @returns {GetCartShareLinkParam} */
   static getCartShareLink() {
     return Joi.object({
-      body: CartPlatformModel.GetShareCartLinkRequest().required(),
+      body: CartPlatformModel.GetShareCartLinkCreation().required(),
     }).required();
   }
 
@@ -665,6 +707,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();
   }
 
@@ -713,6 +762,7 @@ class CartPlatformApplicationValidator {
       promotionGroup: Joi.string().allow(""),
       storeId: Joi.number(),
       cartType: Joi.string().allow(""),
+      sortBy: Joi.string().allow(""),
     }).required();
   }
 
@@ -735,6 +785,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();
   }
 
@@ -774,7 +831,15 @@ class CartPlatformApplicationValidator {
       buyNow: Joi.boolean(),
       orderType: Joi.string().allow(""),
       id: Joi.string().allow(""),
-      body: CartPlatformModel.PlatformAddCartRequest().required(),
+      body: CartPlatformModel.PlatformAddCartDetails().required(),
+    }).required();
+  }
+
+  /** @returns {PlatformCheckoutCartParam} */
+  static platformCheckoutCart() {
+    return Joi.object({
+      id: Joi.string().allow(""),
+      body: CartPlatformModel.PlatformCartCheckoutDetailCreation().required(),
     }).required();
   }
 
@@ -782,7 +847,7 @@ class CartPlatformApplicationValidator {
   static platformCheckoutCartV2() {
     return Joi.object({
       id: Joi.string().allow(""),
-      body: CartPlatformModel.PlatformCartCheckoutDetailV2Request().required(),
+      body: CartPlatformModel.PlatformCartCheckoutDetailV2Creation().required(),
     }).required();
   }
 
@@ -794,7 +859,7 @@ class CartPlatformApplicationValidator {
       orderType: Joi.string().allow(""),
       b: Joi.boolean(),
       buyNow: Joi.boolean(),
-      body: CartPlatformModel.PlatformUpdateCartRequest().required(),
+      body: CartPlatformModel.PlatformUpdateCartDetails().required(),
     }).required();
   }
 
@@ -828,7 +893,7 @@ class CartPlatformApplicationValidator {
       buyNow: Joi.boolean(),
       i: Joi.boolean(),
       b: Joi.boolean(),
-      body: CartPlatformModel.PlatformSelectCartAddressRequest().required(),
+      body: CartPlatformModel.PlatformSelectCartAddress().required(),
     }).required();
   }
 
@@ -838,7 +903,7 @@ class CartPlatformApplicationValidator {
       id: Joi.string().allow(""),
       buyNow: Joi.boolean(),
       orderType: Joi.string().allow(""),
-      body: CartPlatformModel.UpdateCartPaymentRequest().required(),
+      body: CartPlatformModel.CartPaymentUpdate().required(),
     }).required();
   }
 
@@ -865,7 +930,7 @@ class CartPlatformApplicationValidator {
     return Joi.object({
       cartId: Joi.string().allow("").required(),
       b: Joi.boolean(),
-      body: CartPlatformModel.UpdateCartRequest().required(),
+      body: CartPlatformModel.UpdateCartCreation().required(),
     }).required();
   }
 
@@ -874,7 +939,7 @@ class CartPlatformApplicationValidator {
     return Joi.object({
       id: Joi.string().allow(""),
       buyNow: Joi.boolean(),
-      body: CartPlatformModel.PlatformCartMetaRequest().required(),
+      body: CartPlatformModel.PlatformCartMetaCreation().required(),
     }).required();
   }
 
@@ -952,7 +1017,7 @@ class CartPlatformApplicationValidator {
       addressId: Joi.string().allow(""),
       areaCode: Joi.string().allow(""),
       orderType: Joi.string().allow(""),
-      body: CartPlatformModel.UpdateCartShipmentRequest().required(),
+      body: CartPlatformModel.UpdateCartShipmentCreation().required(),
     }).required();
   }