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

package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts

@@ -104,12 +104,15 @@ export = CartPlatformApplicationValidator;
  */
 /**
  * @typedef GetCartParam
- * @property {string} [id]
- * @property {string} [userId]
- * @property {boolean} [i]
- * @property {boolean} [b]
- * @property {number} [assignCardId]
- * @property {boolean} [buyNow]
+ * @property {string} [id] - The unique identifier of the cart
+ * @property {string} [userId] - Option to fetch cart for the provided user_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 {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
  */
 /**
  * @typedef GetCartListParam
@@ -148,7 +151,7 @@ export = CartPlatformApplicationValidator;
 /**
  * @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 GetPromosCouponConfigParam
@@ -199,28 +202,34 @@ export = CartPlatformApplicationValidator;
  */
 /**
  * @typedef PlatformAddItemsParam
- * @property {boolean} [i]
- * @property {boolean} [b]
- * @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 {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 {CartPlatformModel.PlatformAddCartRequest} body
  */
 /**
  * @typedef PlatformCheckoutCartParam
- * @property {string} [id]
+ * @property {string} [id] - The unique identifier of the cart
  * @property {CartPlatformModel.PlatformCartCheckoutDetailRequest} body
  */
 /**
  * @typedef PlatformCheckoutCartV2Param
- * @property {string} [id]
+ * @property {string} [id] - The unique identifier of the cart
  * @property {CartPlatformModel.PlatformCartCheckoutDetailV2Request} body
  */
 /**
  * @typedef PlatformUpdateCartParam
- * @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 a boolen value. Select `true` to
+ *   set/initialize buy now cart
  * @property {CartPlatformModel.PlatformUpdateCartRequest} body
  */
 /**
@@ -282,7 +291,8 @@ export = CartPlatformApplicationValidator;
  */
 /**
  * @typedef UpdateCartMetaConfigParam
- * @property {string} cartMetaId
+ * @property {string} cartMetaId - CartMeta mongo _id for fetching single cart
+ *   meta data for editing
  * @property {CartPlatformModel.CartMetaConfigUpdate} body
  */
 /**
@@ -556,11 +566,32 @@ type GetAvailableDeliveryModesParam = {
     id?: string;
 };
 type GetCartParam = {
+    /**
+     * - The unique identifier of the cart
+     */
     id?: string;
+    /**
+     * - Option to fetch cart for the provided user_id.
+     */
     userId?: 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;
+    /**
+     * - Token of user's debit or credit card
+     */
     assignCardId?: number;
+    /**
+     * - This is a boolen value. Select `true` to
+     * set/initialize buy now cart
+     */
     buyNow?: boolean;
 };
 type GetCartListParam = {
@@ -598,6 +629,9 @@ type GetItemCountParam = {
      * - The unique identifier of the cart.
      */
     id?: string;
+    /**
+     * - Boolean value to get buy_now cart.
+     */
     buyNow?: boolean;
 };
 type GetPromosCouponConfigParam = {
@@ -665,24 +699,60 @@ type OverrideCartParam = {
     body: CartPlatformModel.OverrideCheckoutReq;
 };
 type PlatformAddItemsParam = {
+    /**
+     * - 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 boolen value. Select `true` to
+     * set/initialize buy now cart
+     */
     buyNow?: boolean;
+    /**
+     * - The unique identifier of the cart
+     */
     id?: string;
     body: CartPlatformModel.PlatformAddCartRequest;
 };
 type PlatformCheckoutCartParam = {
+    /**
+     * - The unique identifier of the cart
+     */
     id?: string;
     body: CartPlatformModel.PlatformCartCheckoutDetailRequest;
 };
 type PlatformCheckoutCartV2Param = {
+    /**
+     * - The unique identifier of the cart
+     */
     id?: string;
     body: CartPlatformModel.PlatformCartCheckoutDetailV2Request;
 };
 type PlatformUpdateCartParam = {
+    /**
+     * - 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 boolen value. Select `true` to
+     * set/initialize buy now cart
+     */
     buyNow?: boolean;
     body: CartPlatformModel.PlatformUpdateCartRequest;
 };
@@ -753,6 +823,10 @@ type UpdateCartMetaParam = {
     body: CartPlatformModel.PlatformCartMetaRequest;
 };
 type UpdateCartMetaConfigParam = {
+    /**
+     * - CartMeta mongo _id for fetching single cart
+     * meta data for editing
+     */
     cartMetaId: string;
     body: CartPlatformModel.CartMetaConfigUpdate;
 };

package/sdk/platform/Cart/CartPlatformApplicationValidator.js

@@ -125,12 +125,15 @@ const CartPlatformModel = require("./CartPlatformModel");
 
 /**
  * @typedef GetCartParam
- * @property {string} [id]
- * @property {string} [userId]
- * @property {boolean} [i]
- * @property {boolean} [b]
- * @property {number} [assignCardId]
- * @property {boolean} [buyNow]
+ * @property {string} [id] - The unique identifier of the cart
+ * @property {string} [userId] - Option to fetch cart for the provided user_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 {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
  */
 
 /**
@@ -177,7 +180,7 @@ const CartPlatformModel = require("./CartPlatformModel");
 /**
  * @typedef GetItemCountParam
  * @property {string} [id] - The unique identifier of the cart.
- * @property {boolean} [buyNow]
+ * @property {boolean} [buyNow] - Boolean value to get buy_now cart.
  */
 
 /**
@@ -236,31 +239,37 @@ const CartPlatformModel = require("./CartPlatformModel");
 
 /**
  * @typedef PlatformAddItemsParam
- * @property {boolean} [i]
- * @property {boolean} [b]
- * @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 {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 {CartPlatformModel.PlatformAddCartRequest} body
  */
 
 /**
  * @typedef PlatformCheckoutCartParam
- * @property {string} [id]
+ * @property {string} [id] - The unique identifier of the cart
  * @property {CartPlatformModel.PlatformCartCheckoutDetailRequest} body
  */
 
 /**
  * @typedef PlatformCheckoutCartV2Param
- * @property {string} [id]
+ * @property {string} [id] - The unique identifier of the cart
  * @property {CartPlatformModel.PlatformCartCheckoutDetailV2Request} body
  */
 
 /**
  * @typedef PlatformUpdateCartParam
- * @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 a boolen value. Select `true` to
+ *   set/initialize buy now cart
  * @property {CartPlatformModel.PlatformUpdateCartRequest} body
  */
 
@@ -332,7 +341,8 @@ const CartPlatformModel = require("./CartPlatformModel");
 
 /**
  * @typedef UpdateCartMetaConfigParam
- * @property {string} cartMetaId
+ * @property {string} cartMetaId - CartMeta mongo _id for fetching single cart
+ *   meta data for editing
  * @property {CartPlatformModel.CartMetaConfigUpdate} body
  */
 

package/sdk/platform/Cart/CartPlatformModel.d.ts

@@ -183,6 +183,7 @@ export = CartPlatformModel;
  * @typedef OperationErrorResponse
  * @property {boolean} [success]
  * @property {string} [message]
+ * @property {string} [error]
  */
 /**
  * @typedef CouponUpdate
@@ -380,6 +381,7 @@ export = CartPlatformModel;
  * @property {Object} [_custom_json] - Custom data stored in promotion
  * @property {PromotionDateMeta} [date_meta]
  * @property {string} [_id] - Promotion id
+ * @property {string[]} [tags]
  */
 /**
  * @typedef PromotionsResponse
@@ -411,6 +413,7 @@ export = CartPlatformModel;
  * @property {Object} buy_rules
  * @property {Object} [_custom_json]
  * @property {PromotionDateMeta} [date_meta]
+ * @property {string[]} [tags]
  */
 /**
  * @typedef PromotionUpdate
@@ -437,6 +440,7 @@ export = CartPlatformModel;
  * @property {Object} buy_rules
  * @property {Object} [_custom_json]
  * @property {PromotionDateMeta} [date_meta]
+ * @property {string[]} [tags]
  */
 /**
  * @typedef PromotionPartialUpdate
@@ -470,6 +474,7 @@ export = CartPlatformModel;
 /**
  * @typedef CartMetaConfigUpdate
  * @property {number} [min_cart_value]
+ * @property {number} [max_cart_value]
  * @property {boolean} [bulk_coupons]
  * @property {number} [max_cart_items]
  * @property {string} [gift_display_text]
@@ -481,6 +486,7 @@ export = CartPlatformModel;
 /**
  * @typedef CartMetaConfigAdd
  * @property {number} [min_cart_value]
+ * @property {number} [max_cart_value]
  * @property {boolean} [bulk_coupons]
  * @property {number} [max_cart_items]
  * @property {string} [gift_display_text]
@@ -1945,6 +1951,7 @@ declare function OperationErrorResponse(): OperationErrorResponse;
 type OperationErrorResponse = {
     success?: boolean;
     message?: string;
+    error?: string;
 };
 /** @returns {CouponUpdate} */
 declare function CouponUpdate(): CouponUpdate;
@@ -2211,6 +2218,7 @@ type PromotionListItem = {
      * - Promotion id
      */
     _id?: string;
+    tags?: string[];
 };
 /** @returns {PromotionsResponse} */
 declare function PromotionsResponse(): PromotionsResponse;
@@ -2247,6 +2255,7 @@ type PromotionAdd = {
     buy_rules: any;
     _custom_json?: any;
     date_meta?: PromotionDateMeta;
+    tags?: string[];
 };
 /** @returns {PromotionUpdate} */
 declare function PromotionUpdate(): PromotionUpdate;
@@ -2277,6 +2286,7 @@ type PromotionUpdate = {
     buy_rules: any;
     _custom_json?: any;
     date_meta?: PromotionDateMeta;
+    tags?: string[];
 };
 /** @returns {PromotionPartialUpdate} */
 declare function PromotionPartialUpdate(): PromotionPartialUpdate;
@@ -2345,6 +2355,7 @@ type DeliveryCharges = {
 declare function CartMetaConfigUpdate(): CartMetaConfigUpdate;
 type CartMetaConfigUpdate = {
     min_cart_value?: number;
+    max_cart_value?: number;
     bulk_coupons?: boolean;
     max_cart_items?: number;
     gift_display_text?: string;
@@ -2357,6 +2368,7 @@ type CartMetaConfigUpdate = {
 declare function CartMetaConfigAdd(): CartMetaConfigAdd;
 type CartMetaConfigAdd = {
     min_cart_value?: number;
+    max_cart_value?: number;
     bulk_coupons?: boolean;
     max_cart_items?: number;
     gift_display_text?: string;

package/sdk/platform/Cart/CartPlatformModel.js

@@ -209,6 +209,7 @@ const Joi = require("joi");
  * @typedef OperationErrorResponse
  * @property {boolean} [success]
  * @property {string} [message]
+ * @property {string} [error]
  */
 
 /**
@@ -427,6 +428,7 @@ const Joi = require("joi");
  * @property {Object} [_custom_json] - Custom data stored in promotion
  * @property {PromotionDateMeta} [date_meta]
  * @property {string} [_id] - Promotion id
+ * @property {string[]} [tags]
  */
 
 /**
@@ -460,6 +462,7 @@ const Joi = require("joi");
  * @property {Object} buy_rules
  * @property {Object} [_custom_json]
  * @property {PromotionDateMeta} [date_meta]
+ * @property {string[]} [tags]
  */
 
 /**
@@ -487,6 +490,7 @@ const Joi = require("joi");
  * @property {Object} buy_rules
  * @property {Object} [_custom_json]
  * @property {PromotionDateMeta} [date_meta]
+ * @property {string[]} [tags]
  */
 
 /**
@@ -525,6 +529,7 @@ const Joi = require("joi");
 /**
  * @typedef CartMetaConfigUpdate
  * @property {number} [min_cart_value]
+ * @property {number} [max_cart_value]
  * @property {boolean} [bulk_coupons]
  * @property {number} [max_cart_items]
  * @property {string} [gift_display_text]
@@ -537,6 +542,7 @@ const Joi = require("joi");
 /**
  * @typedef CartMetaConfigAdd
  * @property {number} [min_cart_value]
+ * @property {number} [max_cart_value]
  * @property {boolean} [bulk_coupons]
  * @property {number} [max_cart_items]
  * @property {string} [gift_display_text]
@@ -2170,6 +2176,7 @@ class CartPlatformModel {
     return Joi.object({
       success: Joi.boolean(),
       message: Joi.string().allow(""),
+      error: Joi.string().allow(""),
     });
   }
 
@@ -2429,6 +2436,7 @@ class CartPlatformModel {
       _custom_json: Joi.any(),
       date_meta: CartPlatformModel.PromotionDateMeta(),
       _id: Joi.string().allow(""),
+      tags: Joi.array().items(Joi.string().allow("")),
     });
   }
 
@@ -2469,6 +2477,7 @@ class CartPlatformModel {
         .required(),
       _custom_json: Joi.any(),
       date_meta: CartPlatformModel.PromotionDateMeta(),
+      tags: Joi.array().items(Joi.string().allow("")),
     });
   }
 
@@ -2501,6 +2510,7 @@ class CartPlatformModel {
         .required(),
       _custom_json: Joi.any(),
       date_meta: CartPlatformModel.PromotionDateMeta(),
+      tags: Joi.array().items(Joi.string().allow("")),
     });
   }
 
@@ -2548,6 +2558,7 @@ class CartPlatformModel {
   static CartMetaConfigUpdate() {
     return Joi.object({
       min_cart_value: Joi.number(),
+      max_cart_value: Joi.number(),
       bulk_coupons: Joi.boolean(),
       max_cart_items: Joi.number(),
       gift_display_text: Joi.string().allow(""),
@@ -2562,6 +2573,7 @@ class CartPlatformModel {
   static CartMetaConfigAdd() {
     return Joi.object({
       min_cart_value: Joi.number(),
+      max_cart_value: Joi.number(),
       bulk_coupons: Joi.boolean(),
       max_cart_items: Joi.number(),
       gift_display_text: Joi.string().allow(""),