@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/application/Cart/CartApplicationValidator.js

@@ -1,13 +1,242 @@
 const Joi = require("joi");
 
-const CartModel = require("./CartApplicationModel");
-class CartValidator {
+const CartApplicationModel = require("./CartApplicationModel");
+
+/**
+ * @typedef AddAddressParam
+ * @property {CartApplicationModel.Address} body
+ */
+
+/**
+ * @typedef AddItemsParam
+ * @property {boolean} [i]
+ * @property {boolean} [b]
+ * @property {string} [areaCode]
+ * @property {boolean} [buyNow]
+ * @property {string} [id]
+ * @property {CartApplicationModel.AddCartRequest} body
+ */
+
+/**
+ * @typedef ApplyCouponParam
+ * @property {boolean} [i]
+ * @property {boolean} [b]
+ * @property {boolean} [p]
+ * @property {string} [id]
+ * @property {boolean} [buyNow]
+ * @property {CartApplicationModel.ApplyCouponRequest} body
+ */
+
+/**
+ * @typedef ApplyRewardPointsParam
+ * @property {string} [id]
+ * @property {boolean} [i]
+ * @property {boolean} [b]
+ * @property {boolean} [buyNow]
+ * @property {CartApplicationModel.RewardPointRequest} body
+ */
+
+/**
+ * @typedef CheckoutCartParam
+ * @property {boolean} [buyNow] - This indicates the type of cart to checkout
+ * @property {CartApplicationModel.CartCheckoutDetailRequest} body
+ */
+
+/**
+ * @typedef CheckoutCartV2Param
+ * @property {boolean} [buyNow] - This indicates the type of cart to checkout
+ * @property {CartApplicationModel.CartCheckoutDetailV2Request} body
+ */
+
+/**
+ * @typedef DeleteCartParam
+ * @property {string} [id] - The unique identifier of the cart.
+ */
+
+/**
+ * @typedef GetAddressByIdParam
+ * @property {string} id
+ * @property {string} [cartId]
+ * @property {boolean} [buyNow]
+ * @property {string} [mobileNo]
+ * @property {string} [checkoutMode]
+ * @property {string} [tags]
+ * @property {boolean} [isDefault]
+ */
+
+/**
+ * @typedef GetAddressesParam
+ * @property {string} [cartId]
+ * @property {boolean} [buyNow]
+ * @property {string} [mobileNo]
+ * @property {string} [checkoutMode]
+ * @property {string} [tags]
+ * @property {boolean} [isDefault]
+ */
+
+/**
+ * @typedef GetBulkDiscountOffersParam
+ * @property {number} [itemId] - The Item ID of the product
+ * @property {string} [articleId] - Article Mongo ID
+ * @property {number} [uid] - UID of the product
+ * @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/
+ */
+
+/**
+ * @typedef GetCartParam
+ * @property {string} [id]
+ * @property {boolean} [i]
+ * @property {boolean} [b]
+ * @property {number} [assignCardId]
+ * @property {string} [areaCode]
+ * @property {boolean} [buyNow]
+ */
+
+/**
+ * @typedef GetCartLastModifiedParam
+ * @property {string} [id]
+ */
+
+/**
+ * @typedef GetCartShareLinkParam
+ * @property {CartApplicationModel.GetShareCartLinkRequest} body
+ */
+
+/**
+ * @typedef GetCartSharedItemsParam
+ * @property {string} token - Token of the shared short link
+ */
+
+/**
+ * @typedef GetCouponsParam
+ * @property {string} [id]
+ * @property {boolean} [buyNow]
+ */
+
+/**
+ * @typedef GetItemCountParam
+ * @property {string} [id] - The unique identifier of the cart.
+ * @property {boolean} [buyNow]
+ */
+
+/**
+ * @typedef GetLadderOffersParam
+ * @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 {string} [storeId] - Store uid of assigned store on PDP page. If
+ *   not passed default first created ladder will be returned
+ * @property {string} [promotionId] - Get ladder information of given promotion
+ *   id explicitely
+ * @property {number} [pageSize] - Number of offers to be fetched to show
+ */
+
+/**
+ * @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] - Store id
+ */
+
+/**
+ * @typedef GetShipmentsParam
+ * @property {boolean} [p] - This is a boolean value. Select `true` for getting
+ *   a payment option in response.
+ * @property {string} [id] - The unique identifier of the cart
+ * @property {boolean} [buyNow]
+ * @property {string} [addressId] - ID allotted to the selected address
+ * @property {string} [areaCode] - The PIN Code of the destination address, e.g. 400059
+ * @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. Digital - If the
+ *   customer wants to buy digital voucher ( for jiogames )
+ */
+
+/**
+ * @typedef RemoveAddressParam
+ * @property {string} id - ID allotted to the selected address
+ */
+
+/**
+ * @typedef RemoveCouponParam
+ * @property {string} [id]
+ * @property {boolean} [buyNow]
+ */
+
+/**
+ * @typedef SelectAddressParam
+ * @property {string} [cartId]
+ * @property {boolean} [buyNow]
+ * @property {boolean} [i]
+ * @property {boolean} [b]
+ * @property {CartApplicationModel.SelectCartAddressRequest} body
+ */
+
+/**
+ * @typedef SelectPaymentModeParam
+ * @property {string} [id]
+ * @property {boolean} [buyNow]
+ * @property {CartApplicationModel.UpdateCartPaymentRequest} body
+ */
+
+/**
+ * @typedef UpdateAddressParam
+ * @property {string} id - ID allotted to the selected address
+ * @property {CartApplicationModel.Address} body
+ */
+
+/**
+ * @typedef UpdateCartParam
+ * @property {string} [id]
+ * @property {boolean} [i]
+ * @property {boolean} [b]
+ * @property {string} [areaCode]
+ * @property {boolean} [buyNow]
+ * @property {CartApplicationModel.UpdateCartRequest} body
+ */
+
+/**
+ * @typedef UpdateCartMetaParam
+ * @property {string} [id]
+ * @property {boolean} [buyNow]
+ * @property {CartApplicationModel.CartMetaRequest} body
+ */
+
+/**
+ * @typedef UpdateCartWithSharedItemsParam
+ * @property {string} token - Token of the shared short link
+ * @property {string} action - Operation to perform on the existing cart merge or replace.
+ */
+
+/**
+ * @typedef ValidateCouponForPaymentParam
+ * @property {string} [id]
+ * @property {boolean} [buyNow]
+ * @property {string} [addressId]
+ * @property {string} [paymentMode]
+ * @property {string} [paymentIdentifier]
+ * @property {string} [aggregatorName]
+ * @property {string} [merchantCode]
+ * @property {string} [iin]
+ * @property {string} [network]
+ * @property {string} [type]
+ * @property {string} [cardId]
+ */
+
+class CartApplicationValidator {
+  /** @returns {AddAddressParam} */
   static addAddress() {
     return Joi.object({
-      body: CartModel.Address().required(),
+      body: CartApplicationModel.Address().required(),
     }).required();
   }
 
+  /** @returns {AddItemsParam} */
   static addItems() {
     return Joi.object({
       i: Joi.boolean(),
@@ -15,10 +244,11 @@ class CartValidator {
       areaCode: Joi.string().allow(""),
       buyNow: Joi.boolean(),
       id: Joi.string().allow(""),
-      body: CartModel.AddCartRequest().required(),
+      body: CartApplicationModel.AddCartRequest().required(),
     }).required();
   }
 
+  /** @returns {ApplyCouponParam} */
   static applyCoupon() {
     return Joi.object({
       i: Joi.boolean(),
@@ -26,40 +256,45 @@ class CartValidator {
       p: Joi.boolean(),
       id: Joi.string().allow(""),
       buyNow: Joi.boolean(),
-      body: CartModel.ApplyCouponRequest().required(),
+      body: CartApplicationModel.ApplyCouponRequest().required(),
     }).required();
   }
 
+  /** @returns {ApplyRewardPointsParam} */
   static applyRewardPoints() {
     return Joi.object({
       id: Joi.string().allow(""),
       i: Joi.boolean(),
       b: Joi.boolean(),
       buyNow: Joi.boolean(),
-      body: CartModel.RewardPointRequest().required(),
+      body: CartApplicationModel.RewardPointRequest().required(),
     }).required();
   }
 
+  /** @returns {CheckoutCartParam} */
   static checkoutCart() {
     return Joi.object({
       buyNow: Joi.boolean(),
-      body: CartModel.CartCheckoutDetailRequest().required(),
+      body: CartApplicationModel.CartCheckoutDetailRequest().required(),
     }).required();
   }
 
+  /** @returns {CheckoutCartV2Param} */
   static checkoutCartV2() {
     return Joi.object({
       buyNow: Joi.boolean(),
-      body: CartModel.CartCheckoutDetailV2Request().required(),
+      body: CartApplicationModel.CartCheckoutDetailV2Request().required(),
     }).required();
   }
 
+  /** @returns {DeleteCartParam} */
   static deleteCart() {
     return Joi.object({
       id: Joi.string().allow(""),
     });
   }
 
+  /** @returns {GetAddressByIdParam} */
   static getAddressById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
@@ -72,6 +307,7 @@ class CartValidator {
     }).required();
   }
 
+  /** @returns {GetAddressesParam} */
   static getAddresses() {
     return Joi.object({
       cartId: Joi.string().allow(""),
@@ -83,6 +319,7 @@ class CartValidator {
     });
   }
 
+  /** @returns {GetBulkDiscountOffersParam} */
   static getBulkDiscountOffers() {
     return Joi.object({
       itemId: Joi.number(),
@@ -92,6 +329,7 @@ class CartValidator {
     });
   }
 
+  /** @returns {GetCartParam} */
   static getCart() {
     return Joi.object({
       id: Joi.string().allow(""),
@@ -103,24 +341,28 @@ class CartValidator {
     });
   }
 
+  /** @returns {GetCartLastModifiedParam} */
   static getCartLastModified() {
     return Joi.object({
       id: Joi.string().allow(""),
     });
   }
 
+  /** @returns {GetCartShareLinkParam} */
   static getCartShareLink() {
     return Joi.object({
-      body: CartModel.GetShareCartLinkRequest().required(),
+      body: CartApplicationModel.GetShareCartLinkRequest().required(),
     }).required();
   }
 
+  /** @returns {GetCartSharedItemsParam} */
   static getCartSharedItems() {
     return Joi.object({
       token: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetCouponsParam} */
   static getCoupons() {
     return Joi.object({
       id: Joi.string().allow(""),
@@ -128,6 +370,7 @@ class CartValidator {
     });
   }
 
+  /** @returns {GetItemCountParam} */
   static getItemCount() {
     return Joi.object({
       id: Joi.string().allow(""),
@@ -135,6 +378,7 @@ class CartValidator {
     });
   }
 
+  /** @returns {GetLadderOffersParam} */
   static getLadderOffers() {
     return Joi.object({
       slug: Joi.string().allow("").required(),
@@ -144,6 +388,7 @@ class CartValidator {
     }).required();
   }
 
+  /** @returns {GetPromotionOffersParam} */
   static getPromotionOffers() {
     return Joi.object({
       slug: Joi.string().allow(""),
@@ -153,6 +398,7 @@ class CartValidator {
     });
   }
 
+  /** @returns {GetShipmentsParam} */
   static getShipments() {
     return Joi.object({
       p: Joi.boolean(),
@@ -164,12 +410,14 @@ class CartValidator {
     });
   }
 
+  /** @returns {RemoveAddressParam} */
   static removeAddress() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {RemoveCouponParam} */
   static removeCoupon() {
     return Joi.object({
       id: Joi.string().allow(""),
@@ -177,31 +425,35 @@ class CartValidator {
     });
   }
 
+  /** @returns {SelectAddressParam} */
   static selectAddress() {
     return Joi.object({
       cartId: Joi.string().allow(""),
       buyNow: Joi.boolean(),
       i: Joi.boolean(),
       b: Joi.boolean(),
-      body: CartModel.SelectCartAddressRequest().required(),
+      body: CartApplicationModel.SelectCartAddressRequest().required(),
     }).required();
   }
 
+  /** @returns {SelectPaymentModeParam} */
   static selectPaymentMode() {
     return Joi.object({
       id: Joi.string().allow(""),
       buyNow: Joi.boolean(),
-      body: CartModel.UpdateCartPaymentRequest().required(),
+      body: CartApplicationModel.UpdateCartPaymentRequest().required(),
     }).required();
   }
 
+  /** @returns {UpdateAddressParam} */
   static updateAddress() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: CartModel.Address().required(),
+      body: CartApplicationModel.Address().required(),
     }).required();
   }
 
+  /** @returns {UpdateCartParam} */
   static updateCart() {
     return Joi.object({
       id: Joi.string().allow(""),
@@ -209,18 +461,20 @@ class CartValidator {
       b: Joi.boolean(),
       areaCode: Joi.string().allow(""),
       buyNow: Joi.boolean(),
-      body: CartModel.UpdateCartRequest().required(),
+      body: CartApplicationModel.UpdateCartRequest().required(),
     }).required();
   }
 
+  /** @returns {UpdateCartMetaParam} */
   static updateCartMeta() {
     return Joi.object({
       id: Joi.string().allow(""),
       buyNow: Joi.boolean(),
-      body: CartModel.CartMetaRequest().required(),
+      body: CartApplicationModel.CartMetaRequest().required(),
     }).required();
   }
 
+  /** @returns {UpdateCartWithSharedItemsParam} */
   static updateCartWithSharedItems() {
     return Joi.object({
       token: Joi.string().allow("").required(),
@@ -228,6 +482,7 @@ class CartValidator {
     }).required();
   }
 
+  /** @returns {ValidateCouponForPaymentParam} */
   static validateCouponForPayment() {
     return Joi.object({
       id: Joi.string().allow(""),
@@ -245,4 +500,4 @@ class CartValidator {
   }
 }
 
-module.exports = CartValidator;
+module.exports = CartApplicationValidator;