@gofynd/fdk-client-javascript 1.4.8-beta.3 → 1.4.9

package/sdk/application/Cart/CartApplicationValidator.js

@@ -9,14 +9,11 @@ const CartApplicationModel = require("./CartApplicationModel");
 
 /**
  * @typedef AddItemsParam
- * @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
- *   the price breakup of cart items.
- * @property {string} [areaCode] - Customer servicable area_code
- * @property {boolean} [buyNow] - This is a boolen value. Select `true` to
- *   set/initialize buy now cart
- * @property {string} [id] - The unique identifier of the cart
+ * @property {boolean} [i] - Select `true` to retrieve all the items added in the cart.
+ * @property {boolean} [b] - Select `true` to retrieve the price breakup of cart items.
+ * @property {string} [areaCode] - Customer servicable area_code.
+ * @property {boolean} [buyNow] - Select `true` to set/initialize buy now cart.
+ * @property {string} [id] - The unique identifier of the 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.
@@ -25,37 +22,35 @@ const CartApplicationModel = require("./CartApplicationModel");
 
 /**
  * @typedef ApplyCouponParam
- * @property {boolean} [i]
- * @property {boolean} [b]
- * @property {boolean} [p]
- * @property {string} [id]
- * @property {boolean} [buyNow]
- * @property {string} [cartType]
+ * @property {boolean} [i] - Select `true` to retrieve all the items added in the cart.
+ * @property {boolean} [b] - Select `true` to retrieve the price breakup of cart items.
+ * @property {boolean} [p] - Select `true` for getting a payment option in response.
+ * @property {string} [id] - The unique identifier of the cart.
+ * @property {boolean} [buyNow] - This is boolean to get buy_now cart.
+ * @property {string} [cartType] - The type of cart.
  * @property {CartApplicationModel.ApplyCouponRequest} body
  */
 
 /**
  * @typedef ApplyRewardPointsParam
- * @property {string} [id] - The unique identifier of the cart
- * @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
- *   the price breakup of cart items.
- * @property {boolean} [buyNow] - This is boolean to get buy_now cart
+ * @property {string} [id] - The unique identifier of the cart.
+ * @property {boolean} [i] - Select `true` to retrieve all the items added in the cart.
+ * @property {boolean} [b] - Select `true` to retrieve the price breakup of cart items.
+ * @property {boolean} [buyNow] - This is boolean to get buy_now cart.
  * @property {CartApplicationModel.RewardPointRequest} body
  */
 
 /**
  * @typedef CheckoutCartParam
- * @property {boolean} [buyNow] - This indicates the type of cart to checkout
- * @property {string} [cartType] - The type of cart
+ * @property {boolean} [buyNow] - This indicates the type of cart to checkout.
+ * @property {string} [cartType] - The type of cart.
  * @property {CartApplicationModel.CartCheckoutDetailRequest} body
  */
 
 /**
  * @typedef CheckoutCartV2Param
- * @property {boolean} [buyNow] - This indicates the type of cart to checkout
- * @property {string} [cartType] - The type of cart
+ * @property {boolean} [buyNow] - This indicates the type of cart to checkout.
+ * @property {string} [cartType] - The type of cart.
  * @property {CartApplicationModel.CartCheckoutDetailV2Request} body
  */
 
@@ -66,48 +61,45 @@ const CartApplicationModel = require("./CartApplicationModel");
 
 /**
  * @typedef GetAddressByIdParam
- * @property {string} id
- * @property {string} [cartId]
- * @property {boolean} [buyNow]
- * @property {string} [mobileNo]
- * @property {string} [checkoutMode]
- * @property {string} [tags]
- * @property {boolean} [isDefault]
+ * @property {string} id - ID allotted to the selected address.
+ * @property {string} [cartId] - The unique identifier of the cart.
+ * @property {boolean} [buyNow] - This is boolean to get buy_now cart.
+ * @property {string} [mobileNo] - Mobile number of the customer.
+ * @property {string} [checkoutMode] - Option to checkout for self or for others.
+ * @property {string} [tags] - Tag given to an address, e.g. work, home, office, shop.
+ * @property {boolean} [isDefault] - This is a boolean value. Select `true` to
+ *   fetch the default address.
  */
 
 /**
  * @typedef GetAddressesParam
- * @property {string} [cartId]
- * @property {boolean} [buyNow]
- * @property {string} [mobileNo]
- * @property {string} [checkoutMode]
- * @property {string} [tags]
- * @property {boolean} [isDefault]
+ * @property {string} [cartId] - The unique identifier of the user cart.
+ * @property {boolean} [buyNow] - Whether to get buy_now cart.
+ * @property {string} [mobileNo] - Mobile number of the customer.
+ * @property {string} [checkoutMode] - Option to checkout for self or for others.
+ * @property {string} [tags] - Tag given to an address, e.g. work, home, office, shop.
+ * @property {boolean} [isDefault] - Select `true` to fetch the default address.
  */
 
 /**
  * @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 {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/
+ *   of a product.
  */
 
 /**
  * @typedef GetCartParam
- * @property {string} [id] - The unique identifier of the cart
- * @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
- *   the price breakup of cart items.
- * @property {boolean} [c] - This is a boolean value. Select `true` to retrieve
- *   the cod charges in breakup of cart items.
- * @property {number} [assignCardId] - Token of user's debit or credit card
- * @property {string} [areaCode] - Customer servicable area_code
- * @property {boolean} [buyNow] - This is a boolen value. Select `true` to
- *   set/initialize buy now cart
+ * @property {string} [id] - The unique identifier of the cart.
+ * @property {boolean} [i] - Select `true` to retrieve all the items added in the cart.
+ * @property {boolean} [b] - Select `true` to retrieve the price breakup of cart items.
+ * @property {boolean} [c] - Select `true` to retrieve the cod charges in
+ *   breakup of cart items.
+ * @property {number} [assignCardId] - Token of user's debit or credit card.
+ * @property {string} [areaCode] - Customer servicable area_code.
+ * @property {boolean} [buyNow] - 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.
@@ -115,7 +107,7 @@ const CartApplicationModel = require("./CartApplicationModel");
 
 /**
  * @typedef GetCartLastModifiedParam
- * @property {string} [id]
+ * @property {string} [id] - The unique identifier of the cart.
  */
 
 /**
@@ -125,110 +117,104 @@ const CartApplicationModel = require("./CartApplicationModel");
 
 /**
  * @typedef GetCartSharedItemsParam
- * @property {string} token - Token of the shared short link
+ * @property {string} token - Token of the shared short link.
  */
 
 /**
  * @typedef GetCouponsParam
- * @property {string} [id]
- * @property {boolean} [buyNow]
- * @property {string} [slug]
- * @property {string} [storeId]
+ * @property {string} [id] - The unique identifier of the cart.
+ * @property {boolean} [buyNow] - Whether to get buy_now cart.
+ * @property {string} [slug] - Product slug to fetch the available coupons.
+ * @property {string} [storeId] - Unique identifier of a store.
  */
 
 /**
  * @typedef GetItemCountParam
  * @property {string} [id] - The unique identifier of the cart.
- * @property {boolean} [buyNow]
+ * @property {boolean} [buyNow] - Boolean value to get buy_now cart.
  */
 
 /**
  * @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/
+ *   a product.
  * @property {string} [storeId] - Store uid of assigned store on PDP page. If
- *   not passed default first created ladder will be returned
+ *   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
+ *   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
- * @property {string} [cartType] - The type of cart
+ *   of a product.
+ * @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
- * @property {number} [uid] - Cart uid
+ * @property {string} [id] - Cart id of the user cart .
+ * @property {number} [uid] - Cart uid of the user cart .
  */
 
 /**
  * @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 {boolean} [p] - Select `true` for getting a payment option in response.
+ * @property {string} [id] - The unique identifier of the cart.
+ * @property {boolean} [buyNow] - This is boolean to get buy_now cart.
+ * @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 )
+ *   customer wants to buy digital voucher ( for jiogames ).
  */
 
 /**
  * @typedef RemoveAddressParam
- * @property {string} id - ID allotted to the selected address
+ * @property {string} id - ID allotted to the selected address.
  */
 
 /**
  * @typedef RemoveCouponParam
- * @property {string} [id] - The unique identifier of the cart
- * @property {boolean} [buyNow] - This is boolean to get buy_now cart
+ * @property {string} [id] - The unique identifier of the cart.
+ * @property {boolean} [buyNow] - Wheter to get buy_now cart.
  */
 
 /**
  * @typedef SelectAddressParam
- * @property {string} [cartId]
- * @property {boolean} [buyNow]
- * @property {boolean} [i]
- * @property {boolean} [b]
+ * @property {string} [cartId] - The unique identifier of the cart.
+ * @property {boolean} [buyNow] - Whether to get buy_now cart.
+ * @property {boolean} [i] - Select `true` to retrieve all the items added in the cart.
+ * @property {boolean} [b] - Select `true` to retrieve the price breakup of cart items.
  * @property {CartApplicationModel.SelectCartAddressRequest} body
  */
 
 /**
  * @typedef SelectPaymentModeParam
- * @property {string} [id]
- * @property {boolean} [buyNow]
+ * @property {string} [id] - The unique identifier of the cart.
+ * @property {boolean} [buyNow] - Whether to get buy_now cart.
  * @property {CartApplicationModel.UpdateCartPaymentRequest} body
  */
 
 /**
  * @typedef UpdateAddressParam
- * @property {string} id - ID allotted to the selected address
+ * @property {string} id - ID allotted to the selected address.
  * @property {CartApplicationModel.Address} body
  */
 
 /**
  * @typedef UpdateCartParam
- * @property {string} [id] - The unique identifier of the cart
- * @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
- *   the price breakup of cart items.
- * @property {string} [areaCode] - Customer servicable area_code
- * @property {boolean} [buyNow] - This is a boolen value. Select `true` to
- *   set/initialize buy now cart
- * @property {string} [cartType] - The type of cart
+ * @property {string} [id] - The unique identifier of the cart.
+ * @property {boolean} [i] - Select `true` to retrieve all the items added in the cart.
+ * @property {boolean} [b] - Select `true` to retrieve the price breakup of cart items.
+ * @property {string} [areaCode] - Customer servicable area_code.
+ * @property {boolean} [buyNow] - Select `true` to set/initialize buy now cart.
+ * @property {string} [cartType] - The type of 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.
@@ -237,32 +223,32 @@ const CartApplicationModel = require("./CartApplicationModel");
 
 /**
  * @typedef UpdateCartMetaParam
- * @property {string} [id]
- * @property {boolean} [buyNow]
+ * @property {string} [id] - The unique identifier of the cart.
+ * @property {boolean} [buyNow] - Whether to get buy_now cart.
  * @property {CartApplicationModel.CartMetaRequest} body
  */
 
 /**
  * @typedef UpdateCartWithSharedItemsParam
- * @property {string} token - Token of the shared short link
+ * @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] - The unique identifier of the cart
- * @property {boolean} [buyNow] - This is boolean to get buy_now cart
- * @property {string} [addressId] - ID allotted to an address
- * @property {string} [paymentMode] - Payment mode selected by the customer
- * @property {string} [paymentIdentifier] - Identifier of payment like ICIC, PAYTM
- * @property {string} [aggregatorName] - Payment gateway identifier
+ * @property {string} [id] - The unique identifier of the cart.
+ * @property {boolean} [buyNow] - Whether to get buy_now cart.
+ * @property {string} [addressId] - ID allotted to an address.
+ * @property {string} [paymentMode] - Payment mode selected by the customer.
+ * @property {string} [paymentIdentifier] - Identifier of payment like ICIC, PAYTM.
+ * @property {string} [aggregatorName] - Payment gateway identifier.
  * @property {string} [merchantCode] - Identifier used by payment gateway for a
- *   given payment mode, e.g. NB_ICIC, PAYTM
- * @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
+ *   given payment mode, e.g. NB_ICIC, PAYTM.
+ * @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 CartApplicationValidator {