@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.6

package/sdk/application/Cart/CartApplicationValidator.d.ts

@@ -5,11 +5,14 @@ export = CartApplicationValidator;
  */
 /**
  * @typedef AddItemsParam
- * @property {boolean} [i]
- * @property {boolean} [b]
- * @property {string} [areaCode]
- * @property {boolean} [buyNow]
- * @property {string} [id]
+ * @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 {CartApplicationModel.AddCartRequest} body
  */
 /**
@@ -19,24 +22,29 @@ export = CartApplicationValidator;
  * @property {boolean} [p]
  * @property {string} [id]
  * @property {boolean} [buyNow]
+ * @property {string} [cartType]
  * @property {CartApplicationModel.ApplyCouponRequest} body
  */
 /**
  * @typedef ApplyRewardPointsParam
- * @property {string} [id]
- * @property {boolean} [i]
- * @property {boolean} [b]
- * @property {boolean} [buyNow]
+ * @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 {CartApplicationModel.RewardPointRequest} body
  */
 /**
  * @typedef CheckoutCartParam
  * @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 {CartApplicationModel.CartCheckoutDetailV2Request} body
  */
 /**
@@ -73,13 +81,17 @@ export = CartApplicationValidator;
  */
 /**
  * @typedef GetCartParam
- * @property {string} [id]
- * @property {boolean} [i]
- * @property {boolean} [b]
- * @property {boolean} [c]
- * @property {number} [assignCardId]
- * @property {string} [areaCode]
- * @property {boolean} [buyNow]
+ * @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
  */
 /**
  * @typedef GetCartLastModifiedParam
@@ -124,6 +136,7 @@ export = CartApplicationValidator;
  * @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
  */
 /**
  * @typedef GetShipmentsParam
@@ -144,8 +157,8 @@ export = CartApplicationValidator;
  */
 /**
  * @typedef RemoveCouponParam
- * @property {string} [id]
- * @property {boolean} [buyNow]
+ * @property {string} [id] - The unique identifier of the cart
+ * @property {boolean} [buyNow] - This is boolean to get buy_now cart
  */
 /**
  * @typedef SelectAddressParam
@@ -168,11 +181,15 @@ export = CartApplicationValidator;
  */
 /**
  * @typedef UpdateCartParam
- * @property {string} [id]
- * @property {boolean} [i]
- * @property {boolean} [b]
- * @property {string} [areaCode]
- * @property {boolean} [buyNow]
+ * @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 {CartApplicationModel.UpdateCartRequest} body
  */
 /**
@@ -188,17 +205,19 @@ export = CartApplicationValidator;
  */
 /**
  * @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]
+ * @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} [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
  */
 declare class CartApplicationValidator {
     /** @returns {AddAddressParam} */
@@ -265,10 +284,28 @@ type AddAddressParam = {
     body: CartApplicationModel.Address;
 };
 type AddItemsParam = {
+    /**
+     * - This is a boolean value. Select `true` to retrieve
+     * all the items added in the cart.
+     */
     i?: boolean;
+    /**
+     * - This is a boolean value. Select `true` to retrieve
+     * the price breakup of cart items.
+     */
     b?: boolean;
+    /**
+     * - Customer servicable area_code
+     */
     areaCode?: string;
+    /**
+     * - This is a boolen value. Select `true` to
+     * set/initialize buy now cart
+     */
     buyNow?: boolean;
+    /**
+     * - The unique identifier of the cart
+     */
     id?: string;
     body: CartApplicationModel.AddCartRequest;
 };
@@ -278,12 +315,27 @@ type ApplyCouponParam = {
     p?: boolean;
     id?: string;
     buyNow?: boolean;
+    cartType?: string;
     body: CartApplicationModel.ApplyCouponRequest;
 };
 type ApplyRewardPointsParam = {
+    /**
+     * - The unique identifier of the cart
+     */
     id?: string;
+    /**
+     * - This is a boolean value. Select `true` to retrieve
+     * all the items added in the cart.
+     */
     i?: boolean;
+    /**
+     * - This is a boolean value. Select `true` to retrieve
+     * the price breakup of cart items.
+     */
     b?: boolean;
+    /**
+     * - This is boolean to get buy_now cart
+     */
     buyNow?: boolean;
     body: CartApplicationModel.RewardPointRequest;
 };
@@ -292,6 +344,10 @@ type CheckoutCartParam = {
      * - This indicates the type of cart to checkout
      */
     buyNow?: boolean;
+    /**
+     * - The type of cart
+     */
+    cartType?: string;
     body: CartApplicationModel.CartCheckoutDetailRequest;
 };
 type CheckoutCartV2Param = {
@@ -299,6 +355,10 @@ type CheckoutCartV2Param = {
      * - This indicates the type of cart to checkout
      */
     buyNow?: boolean;
+    /**
+     * - The type of cart
+     */
+    cartType?: string;
     body: CartApplicationModel.CartCheckoutDetailV2Request;
 };
 type DeleteCartParam = {
@@ -345,12 +405,37 @@ type GetBulkDiscountOffersParam = {
     slug?: string;
 };
 type GetCartParam = {
+    /**
+     * - The unique identifier of the cart
+     */
     id?: string;
+    /**
+     * - This is a boolean value. Select `true` to retrieve
+     * all the items added in the cart.
+     */
     i?: boolean;
+    /**
+     * - This is a boolean value. Select `true` to retrieve
+     * the price breakup of cart items.
+     */
     b?: boolean;
+    /**
+     * - This is a boolean value. Select `true` to retrieve
+     * the cod charges in breakup of cart items.
+     */
     c?: boolean;
+    /**
+     * - Token of user's debit or credit card
+     */
     assignCardId?: number;
+    /**
+     * - Customer servicable area_code
+     */
     areaCode?: string;
+    /**
+     * - This is a boolen value. Select `true` to
+     * set/initialize buy now cart
+     */
     buyNow?: boolean;
 };
 type GetCartLastModifiedParam = {
@@ -419,6 +504,10 @@ type GetPromotionOffersParam = {
      * - Store id
      */
     storeId?: number;
+    /**
+     * - The type of cart
+     */
+    cartType?: string;
 };
 type GetShipmentsParam = {
     /**
@@ -454,7 +543,13 @@ type RemoveAddressParam = {
     id: string;
 };
 type RemoveCouponParam = {
+    /**
+     * - The unique identifier of the cart
+     */
     id?: string;
+    /**
+     * - This is boolean to get buy_now cart
+     */
     buyNow?: boolean;
 };
 type SelectAddressParam = {
@@ -477,11 +572,33 @@ type UpdateAddressParam = {
     body: CartApplicationModel.Address;
 };
 type UpdateCartParam = {
+    /**
+     * - The unique identifier of the cart
+     */
     id?: string;
+    /**
+     * - This is a boolean value. Select `true` to retrieve
+     * all the items added in the cart.
+     */
     i?: boolean;
+    /**
+     * - This is a boolean value. Select `true` to retrieve
+     * the price breakup of cart items.
+     */
     b?: boolean;
+    /**
+     * - Customer servicable area_code
+     */
     areaCode?: string;
+    /**
+     * - This is a boolen value. Select `true` to
+     * set/initialize buy now cart
+     */
     buyNow?: boolean;
+    /**
+     * - The type of cart
+     */
+    cartType?: string;
     body: CartApplicationModel.UpdateCartRequest;
 };
 type UpdateCartMetaParam = {
@@ -500,16 +617,54 @@ type UpdateCartWithSharedItemsParam = {
     action: string;
 };
 type ValidateCouponForPaymentParam = {
+    /**
+     * - The unique identifier of the cart
+     */
     id?: string;
+    /**
+     * - This is boolean to get buy_now cart
+     */
     buyNow?: boolean;
+    /**
+     * - ID allotted to an address
+     */
     addressId?: string;
+    /**
+     * - Payment mode selected by the customer
+     */
     paymentMode?: string;
+    /**
+     * - Identifier of payment like ICIC, PAYTM
+     */
     paymentIdentifier?: string;
+    /**
+     * - Payment gateway identifier
+     */
     aggregatorName?: string;
+    /**
+     * - Identifier used by payment gateway for a
+     * given payment mode, e.g. NB_ICIC, PAYTM
+     */
     merchantCode?: string;
+    /**
+     * - Debit/Credit card prefix (first 6 digit)
+     */
     iin?: string;
+    /**
+     * - Credit/Debit card issuer, e.g. VISA, MASTERCARD, RUPAY
+     */
     network?: string;
+    /**
+     * - Card type, e.g. Credit, Debit
+     */
     type?: string;
+    /**
+     * - Saved card token reference id
+     */
     cardId?: string;
+    /**
+     * - Type of the cart
+     */
+    cartType?: string;
 };
 import CartApplicationModel = require("./CartApplicationModel");

package/sdk/application/Cart/CartApplicationValidator.js

@@ -9,11 +9,14 @@ const CartApplicationModel = require("./CartApplicationModel");
 
 /**
  * @typedef AddItemsParam
- * @property {boolean} [i]
- * @property {boolean} [b]
- * @property {string} [areaCode]
- * @property {boolean} [buyNow]
- * @property {string} [id]
+ * @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 {CartApplicationModel.AddCartRequest} body
  */
 
@@ -24,27 +27,32 @@ const CartApplicationModel = require("./CartApplicationModel");
  * @property {boolean} [p]
  * @property {string} [id]
  * @property {boolean} [buyNow]
+ * @property {string} [cartType]
  * @property {CartApplicationModel.ApplyCouponRequest} body
  */
 
 /**
  * @typedef ApplyRewardPointsParam
- * @property {string} [id]
- * @property {boolean} [i]
- * @property {boolean} [b]
- * @property {boolean} [buyNow]
+ * @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 {CartApplicationModel.RewardPointRequest} body
  */
 
 /**
  * @typedef CheckoutCartParam
  * @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 {CartApplicationModel.CartCheckoutDetailV2Request} body
  */
 
@@ -86,13 +94,17 @@ const CartApplicationModel = require("./CartApplicationModel");
 
 /**
  * @typedef GetCartParam
- * @property {string} [id]
- * @property {boolean} [i]
- * @property {boolean} [b]
- * @property {boolean} [c]
- * @property {number} [assignCardId]
- * @property {string} [areaCode]
- * @property {boolean} [buyNow]
+ * @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
  */
 
 /**
@@ -144,6 +156,7 @@ const CartApplicationModel = require("./CartApplicationModel");
  * @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
  */
 
 /**
@@ -167,8 +180,8 @@ const CartApplicationModel = require("./CartApplicationModel");
 
 /**
  * @typedef RemoveCouponParam
- * @property {string} [id]
- * @property {boolean} [buyNow]
+ * @property {string} [id] - The unique identifier of the cart
+ * @property {boolean} [buyNow] - This is boolean to get buy_now cart
  */
 
 /**
@@ -195,11 +208,15 @@ const CartApplicationModel = require("./CartApplicationModel");
 
 /**
  * @typedef UpdateCartParam
- * @property {string} [id]
- * @property {boolean} [i]
- * @property {boolean} [b]
- * @property {string} [areaCode]
- * @property {boolean} [buyNow]
+ * @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 {CartApplicationModel.UpdateCartRequest} body
  */
 
@@ -218,17 +235,19 @@ const CartApplicationModel = require("./CartApplicationModel");
 
 /**
  * @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]
+ * @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} [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
  */
 
 class CartApplicationValidator {
@@ -259,6 +278,7 @@ class CartApplicationValidator {
       p: Joi.boolean(),
       id: Joi.string().allow(""),
       buyNow: Joi.boolean(),
+      cartType: Joi.string().allow(""),
       body: CartApplicationModel.ApplyCouponRequest().required(),
     }).required();
   }
@@ -278,6 +298,7 @@ class CartApplicationValidator {
   static checkoutCart() {
     return Joi.object({
       buyNow: Joi.boolean(),
+      cartType: Joi.string().allow(""),
       body: CartApplicationModel.CartCheckoutDetailRequest().required(),
     }).required();
   }
@@ -286,6 +307,7 @@ class CartApplicationValidator {
   static checkoutCartV2() {
     return Joi.object({
       buyNow: Joi.boolean(),
+      cartType: Joi.string().allow(""),
       body: CartApplicationModel.CartCheckoutDetailV2Request().required(),
     }).required();
   }
@@ -401,6 +423,7 @@ class CartApplicationValidator {
       pageSize: Joi.number(),
       promotionGroup: Joi.string().allow(""),
       storeId: Joi.number(),
+      cartType: Joi.string().allow(""),
     });
   }
 
@@ -467,6 +490,7 @@ class CartApplicationValidator {
       b: Joi.boolean(),
       areaCode: Joi.string().allow(""),
       buyNow: Joi.boolean(),
+      cartType: Joi.string().allow(""),
       body: CartApplicationModel.UpdateCartRequest().required(),
     }).required();
   }
@@ -502,6 +526,7 @@ class CartApplicationValidator {
       network: Joi.string().allow(""),
       type: Joi.string().allow(""),
       cardId: Joi.string().allow(""),
+      cartType: Joi.string().allow(""),
     });
   }
 }