@gofynd/fdk-client-javascript 3.3.3 → 3.3.6

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

@@ -184,7 +184,7 @@ export = CartPlatformModel;
  */
 /**
  * @typedef Page
- * @property {number} [item_total] - The total number of items on the page.
+ * @property {number} [item_total] - The total number of all items across all pages.
  * @property {string} [next_id] - The identifier for the next page.
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
  * @property {boolean} [has_next] - Indicates whether there is a next page.
@@ -962,6 +962,8 @@ export = CartPlatformModel;
  *   message for the gift
  * @property {string[]} [product_group_tags] - List fot the unique identifier
  *   for the product grouping.
+ * @property {boolean} [force_new_line_item] - Flag to indicate the item as a
+ *   seperate article in cart
  * @property {Object} [identifier] - Unique identifier of the article
  * @property {number} [mto_quantity] - Quantity of the product which will
  *   specially manufactured as not available in stock
@@ -973,6 +975,7 @@ export = CartPlatformModel;
  * @property {Object} [meta] - Meta data of article in cart
  * @property {string} [size] - Size of the article added in cart
  * @property {StoreInfo} [store]
+ * @property {number} [item_index] - Specify the index of article in cart.
  * @property {string[]} [tags] - A list of article tags
  */
 /**
@@ -1444,6 +1447,8 @@ export = CartPlatformModel;
  *   level while add items to cart
  * @property {Object} [_custom_json] - Field to add custom json at article level
  *   while add items to cart
+ * @property {boolean} [force_new_line_item] - Field used to decide the product
+ *   add as a seperate product in cart
  * @property {Object} [meta] - Field to add meta data at article level
  * @property {boolean} [pos] - Filed to determine whether user is making request
  *   from pos or not
@@ -1487,6 +1492,8 @@ export = CartPlatformModel;
  * @property {Object} [meta] - Field to update meta of the item in cart
  * @property {Object} [extra_meta] - Field to update extra meta of the product in cart
  * @property {Object} [_custom_json] - Field to update custom json of the product in cart
+ * @property {boolean} [force_new_line_item] - Field used to decide the product
+ *   add as a seperate product in cart
  * @property {number} [item_id] - Item id of the product that needs to be updated
  * @property {number} [item_index] - Item index determines on which index the
  *   product falls to be updated
@@ -1731,10 +1738,16 @@ export = CartPlatformModel;
  * @typedef CartItemCountResult
  * @property {number} [user_cart_items_count] - Item count present in cart
  */
+/**
+ * @typedef DiscountRules
+ * @property {number} [discounted_price] - Discount will be reflected in the
+ *   cart upon adding the product.
+ */
 /**
  * @typedef Coupon
  * @property {string} [title] - Coupon Title of the coupon applied denotes name
  *   of the coupon
+ * @property {DiscountRules[]} [rule] - Discount rules of coupons
  * @property {number} [max_discount_value] - Maximum discount value of the
  *   coupon applied to cart
  * @property {string} [coupon_code] - Coupon code of the coupon applied on cart
@@ -1926,6 +1939,8 @@ export = CartPlatformModel;
  * @property {number} [quantity] - Quantity of product in shipment
  * @property {string} shipment_type - Shipment delivery type
  * @property {string} article_uid - Article unique id for shipment
+ * @property {number} [item_index] - Item index determines the position in the
+ *   list where the product should be updated.
  */
 /**
  * @typedef UpdateCartShipmentCreation
@@ -2164,6 +2179,8 @@ export = CartPlatformModel;
  *   mode selected to do the payment
  * @property {string} [merchant_code] - Merchant code of the payment mode
  *   selected to do the payment
+ * @property {string[]} [payment_source_bag_id] - Previous bag IDs for which an
+ *   exchange has been performed.
  */
 /**
  * @typedef PaymentMethod
@@ -2335,7 +2352,7 @@ export = CartPlatformModel;
 declare class CartPlatformModel {
 }
 declare namespace CartPlatformModel {
-    export { CouponDateMeta, Ownership, CouponAuthor, State, PaymentAllowValue, PaymentModes, PriceRange, PostOrder, BulkBundleRestriction, UsesRemaining, UsesRestriction, Restrictions, Validation, CouponAction, CouponSchedule, Rule, DisplayMetaDict, DisplayMeta, Identifier, Validity, RuleDefinition, CouponAdd, Page, CouponsResult, SuccessMessage, OperationErrorResult, CouponUpdate, CouponPartialUpdate, CouponCreateResult, DisplayMeta1, Ownership1, CompareObject, ItemSizeMapping, ItemCriteria, DiscountOffer, DiscountRule, PaymentAllowValue1, PromotionPaymentModes, UserRegistered, PostOrder1, UsesRemaining1, UsesRestriction1, Restrictions1, PromotionSchedule, PromotionAction, PromotionAuthor, Visibility, PromotionDateMeta, PromotionListItem, PromotionsResult, PromotionAdd, PromotionAddResult, PromotionUpdate, PromotionUpdateResult, PromotionPartialUpdate, ActivePromosResult, Charges, DeliveryCharges, CartMetaConfigUpdate, CartMetaConfigAdd, Article, PriceAdjustmentRestrictions, Collection, PriceAdjustmentUpdate, PriceAdjustment, PriceAdjustmentResult, GetPriceAdjustmentResult, PriceAdjustmentAdd, DistributionRule, Distribution, DistributionLogic, CartItem, OpenapiCartDetailsCreation, CouponBreakup, DisplayBreakup, LoyaltyPoints, RawBreakup, CartBreakup, ProductImage, Tags, BaseInfo, ActionQuery, ProductActionParams, ProductActionPage, ProductAction, CategoryInfo, CartProduct, BasePrice, ArticlePriceInfo, StoreInfo, ProductArticle, Ownership2, DiscountRulesApp, AppliedFreeArticles, BuyRules, AppliedPromotion, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, CouponDetails, ProductPrice, ProductPriceInfo, ProductMaxQuantityInfo, CartProductIdentifer, ProductAvailabilitySize, ProductAvailability, PromoMeta, CartProductInfo, OpenapiCartDetailsResult, OpenApiErrorResult, ShippingAddress, OpenApiCartServiceabilityCreation, OpenApiCartServiceabilityResult, OpenApiFiles, CartItemMeta, MultiTenderPaymentMeta, MultiTenderPaymentMethod, OpenApiOrderItem, OpenApiPlatformCheckoutReq, OpenApiCheckoutResult, AbandonedCart, AbandonedCartResult, PaymentSelectionLock, CartCurrency, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig, CartDetailResult, AddProductCart, AddCartCreation, AddCartDetailResult, CartItemInfo, UpdateProductCart, FreeGiftItemCreation, UpdateCartCreation, UpdateCartDetailResult, OverrideCartItemPromo, OverrideCartItem, OverrideCheckoutReq, OverrideCheckoutResult, GetShareCartLinkCreation, GetShareCartLinkResult, SharedCartDetails, SharedCart, SharedCartResult, CartList, MultiCartResult, UpdateUserCartMapping, UserInfo, UserCartMappingResult, PlatformAddCartDetails, PlatformUpdateCartDetails, DeleteCartDetails, DeleteCartDetailResult, CartItemCountResult, Coupon, PageCoupon, GetCouponResult, ApplyCouponDetails, GeoLocation, PlatformAddress, ValidationConfig, PlatformGetAddressesDetails, SaveAddressDetails, UpdateAddressDetails, DeleteAddressResult, PlatformSelectCartAddress, ShipmentArticle, PlatformShipmentDetails, PlatformCartShipmentsResult, UpdateCartShipmentItem, UpdateCartShipmentCreation, PlatformCartMetaCreation, CartMetaDetails, CartMetaMissingDetails, StaffCheckout, CustomerDetails, Files, CartCheckoutCustomMeta, OrderTag, PlatformCartCheckoutDetailCreation, CheckCart, CartCheckoutDetails, CartCheckoutResult, CartDeliveryModesDetails, PickupStoreDetail, StoreDetails, CartPaymentUpdate, CouponValidity, PaymentCouponValidate, PaymentMeta, PaymentMethod, PlatformCartCheckoutDetailV2Creation, UpdateCartPaymentRequestV2, PriceMinMax, ItemPriceDetails, ArticlePriceDetails, FreeGiftItems, PromotionOffer, PromotionOffersDetails, PromotionPaymentOffer, PromotionPaymentOffersDetails, ValidationError, OrderingSource };
+    export { CouponDateMeta, Ownership, CouponAuthor, State, PaymentAllowValue, PaymentModes, PriceRange, PostOrder, BulkBundleRestriction, UsesRemaining, UsesRestriction, Restrictions, Validation, CouponAction, CouponSchedule, Rule, DisplayMetaDict, DisplayMeta, Identifier, Validity, RuleDefinition, CouponAdd, Page, CouponsResult, SuccessMessage, OperationErrorResult, CouponUpdate, CouponPartialUpdate, CouponCreateResult, DisplayMeta1, Ownership1, CompareObject, ItemSizeMapping, ItemCriteria, DiscountOffer, DiscountRule, PaymentAllowValue1, PromotionPaymentModes, UserRegistered, PostOrder1, UsesRemaining1, UsesRestriction1, Restrictions1, PromotionSchedule, PromotionAction, PromotionAuthor, Visibility, PromotionDateMeta, PromotionListItem, PromotionsResult, PromotionAdd, PromotionAddResult, PromotionUpdate, PromotionUpdateResult, PromotionPartialUpdate, ActivePromosResult, Charges, DeliveryCharges, CartMetaConfigUpdate, CartMetaConfigAdd, Article, PriceAdjustmentRestrictions, Collection, PriceAdjustmentUpdate, PriceAdjustment, PriceAdjustmentResult, GetPriceAdjustmentResult, PriceAdjustmentAdd, DistributionRule, Distribution, DistributionLogic, CartItem, OpenapiCartDetailsCreation, CouponBreakup, DisplayBreakup, LoyaltyPoints, RawBreakup, CartBreakup, ProductImage, Tags, BaseInfo, ActionQuery, ProductActionParams, ProductActionPage, ProductAction, CategoryInfo, CartProduct, BasePrice, ArticlePriceInfo, StoreInfo, ProductArticle, Ownership2, DiscountRulesApp, AppliedFreeArticles, BuyRules, AppliedPromotion, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, CouponDetails, ProductPrice, ProductPriceInfo, ProductMaxQuantityInfo, CartProductIdentifer, ProductAvailabilitySize, ProductAvailability, PromoMeta, CartProductInfo, OpenapiCartDetailsResult, OpenApiErrorResult, ShippingAddress, OpenApiCartServiceabilityCreation, OpenApiCartServiceabilityResult, OpenApiFiles, CartItemMeta, MultiTenderPaymentMeta, MultiTenderPaymentMethod, OpenApiOrderItem, OpenApiPlatformCheckoutReq, OpenApiCheckoutResult, AbandonedCart, AbandonedCartResult, PaymentSelectionLock, CartCurrency, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig, CartDetailResult, AddProductCart, AddCartCreation, AddCartDetailResult, CartItemInfo, UpdateProductCart, FreeGiftItemCreation, UpdateCartCreation, UpdateCartDetailResult, OverrideCartItemPromo, OverrideCartItem, OverrideCheckoutReq, OverrideCheckoutResult, GetShareCartLinkCreation, GetShareCartLinkResult, SharedCartDetails, SharedCart, SharedCartResult, CartList, MultiCartResult, UpdateUserCartMapping, UserInfo, UserCartMappingResult, PlatformAddCartDetails, PlatformUpdateCartDetails, DeleteCartDetails, DeleteCartDetailResult, CartItemCountResult, DiscountRules, Coupon, PageCoupon, GetCouponResult, ApplyCouponDetails, GeoLocation, PlatformAddress, ValidationConfig, PlatformGetAddressesDetails, SaveAddressDetails, UpdateAddressDetails, DeleteAddressResult, PlatformSelectCartAddress, ShipmentArticle, PlatformShipmentDetails, PlatformCartShipmentsResult, UpdateCartShipmentItem, UpdateCartShipmentCreation, PlatformCartMetaCreation, CartMetaDetails, CartMetaMissingDetails, StaffCheckout, CustomerDetails, Files, CartCheckoutCustomMeta, OrderTag, PlatformCartCheckoutDetailCreation, CheckCart, CartCheckoutDetails, CartCheckoutResult, CartDeliveryModesDetails, PickupStoreDetail, StoreDetails, CartPaymentUpdate, CouponValidity, PaymentCouponValidate, PaymentMeta, PaymentMethod, PlatformCartCheckoutDetailV2Creation, UpdateCartPaymentRequestV2, PriceMinMax, ItemPriceDetails, ArticlePriceDetails, FreeGiftItems, PromotionOffer, PromotionOffersDetails, PromotionPaymentOffer, PromotionPaymentOffersDetails, ValidationError, OrderingSource };
 }
 /** @returns {CouponDateMeta} */
 declare function CouponDateMeta(): CouponDateMeta;
@@ -2783,7 +2800,7 @@ type CouponAdd = {
 declare function Page(): Page;
 type Page = {
     /**
-     * - The total number of items on the page.
+     * - The total number of all items across all pages.
      */
     item_total?: number;
     /**
@@ -4684,6 +4701,11 @@ type ProductArticle = {
      * for the product grouping.
      */
     product_group_tags?: string[];
+    /**
+     * - Flag to indicate the item as a
+     * seperate article in cart
+     */
+    force_new_line_item?: boolean;
     /**
      * - Unique identifier of the article
      */
@@ -4716,6 +4738,10 @@ type ProductArticle = {
      */
     size?: string;
     store?: StoreInfo;
+    /**
+     * - Specify the index of article in cart.
+     */
+    item_index?: number;
     /**
      * - A list of article tags
      */
@@ -5956,6 +5982,11 @@ type AddProductCart = {
      * while add items to cart
      */
     _custom_json?: any;
+    /**
+     * - Field used to decide the product
+     * add as a seperate product in cart
+     */
+    force_new_line_item?: boolean;
     /**
      * - Field to add meta data at article level
      */
@@ -6066,6 +6097,11 @@ type UpdateProductCart = {
      * - Field to update custom json of the product in cart
      */
     _custom_json?: any;
+    /**
+     * - Field used to decide the product
+     * add as a seperate product in cart
+     */
+    force_new_line_item?: boolean;
     /**
      * - Item id of the product that needs to be updated
      */
@@ -6680,6 +6716,15 @@ type CartItemCountResult = {
      */
     user_cart_items_count?: number;
 };
+/** @returns {DiscountRules} */
+declare function DiscountRules(): DiscountRules;
+type DiscountRules = {
+    /**
+     * - Discount will be reflected in the
+     * cart upon adding the product.
+     */
+    discounted_price?: number;
+};
 /** @returns {Coupon} */
 declare function Coupon(): Coupon;
 type Coupon = {
@@ -6688,6 +6733,10 @@ type Coupon = {
      * of the coupon
      */
     title?: string;
+    /**
+     * - Discount rules of coupons
+     */
+    rule?: DiscountRules[];
     /**
      * - Maximum discount value of the
      * coupon applied to cart
@@ -7209,6 +7258,11 @@ type UpdateCartShipmentItem = {
      * - Article unique id for shipment
      */
     article_uid: string;
+    /**
+     * - Item index determines the position in the
+     * list where the product should be updated.
+     */
+    item_index?: number;
 };
 /** @returns {UpdateCartShipmentCreation} */
 declare function UpdateCartShipmentCreation(): UpdateCartShipmentCreation;
@@ -7773,6 +7827,11 @@ type PaymentMeta = {
      * selected to do the payment
      */
     merchant_code?: string;
+    /**
+     * - Previous bag IDs for which an
+     * exchange has been performed.
+     */
+    payment_source_bag_id?: string[];
 };
 /** @returns {PaymentMethod} */
 declare function PaymentMethod(): PaymentMethod;

package/sdk/platform/Cart/CartPlatformModel.js

@@ -207,7 +207,7 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total] - The total number of items on the page.
+ * @property {number} [item_total] - The total number of all items across all pages.
  * @property {string} [next_id] - The identifier for the next page.
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
  * @property {boolean} [has_next] - Indicates whether there is a next page.
@@ -1053,6 +1053,8 @@ const Joi = require("joi");
  *   message for the gift
  * @property {string[]} [product_group_tags] - List fot the unique identifier
  *   for the product grouping.
+ * @property {boolean} [force_new_line_item] - Flag to indicate the item as a
+ *   seperate article in cart
  * @property {Object} [identifier] - Unique identifier of the article
  * @property {number} [mto_quantity] - Quantity of the product which will
  *   specially manufactured as not available in stock
@@ -1064,6 +1066,7 @@ const Joi = require("joi");
  * @property {Object} [meta] - Meta data of article in cart
  * @property {string} [size] - Size of the article added in cart
  * @property {StoreInfo} [store]
+ * @property {number} [item_index] - Specify the index of article in cart.
  * @property {string[]} [tags] - A list of article tags
  */
 
@@ -1575,6 +1578,8 @@ const Joi = require("joi");
  *   level while add items to cart
  * @property {Object} [_custom_json] - Field to add custom json at article level
  *   while add items to cart
+ * @property {boolean} [force_new_line_item] - Field used to decide the product
+ *   add as a seperate product in cart
  * @property {Object} [meta] - Field to add meta data at article level
  * @property {boolean} [pos] - Filed to determine whether user is making request
  *   from pos or not
@@ -1622,6 +1627,8 @@ const Joi = require("joi");
  * @property {Object} [meta] - Field to update meta of the item in cart
  * @property {Object} [extra_meta] - Field to update extra meta of the product in cart
  * @property {Object} [_custom_json] - Field to update custom json of the product in cart
+ * @property {boolean} [force_new_line_item] - Field used to decide the product
+ *   add as a seperate product in cart
  * @property {number} [item_id] - Item id of the product that needs to be updated
  * @property {number} [item_index] - Item index determines on which index the
  *   product falls to be updated
@@ -1889,10 +1896,17 @@ const Joi = require("joi");
  * @property {number} [user_cart_items_count] - Item count present in cart
  */
 
+/**
+ * @typedef DiscountRules
+ * @property {number} [discounted_price] - Discount will be reflected in the
+ *   cart upon adding the product.
+ */
+
 /**
  * @typedef Coupon
  * @property {string} [title] - Coupon Title of the coupon applied denotes name
  *   of the coupon
+ * @property {DiscountRules[]} [rule] - Discount rules of coupons
  * @property {number} [max_discount_value] - Maximum discount value of the
  *   coupon applied to cart
  * @property {string} [coupon_code] - Coupon code of the coupon applied on cart
@@ -2099,6 +2113,8 @@ const Joi = require("joi");
  * @property {number} [quantity] - Quantity of product in shipment
  * @property {string} shipment_type - Shipment delivery type
  * @property {string} article_uid - Article unique id for shipment
+ * @property {number} [item_index] - Item index determines the position in the
+ *   list where the product should be updated.
  */
 
 /**
@@ -2357,6 +2373,8 @@ const Joi = require("joi");
  *   mode selected to do the payment
  * @property {string} [merchant_code] - Merchant code of the payment mode
  *   selected to do the payment
+ * @property {string[]} [payment_source_bag_id] - Previous bag IDs for which an
+ *   exchange has been performed.
  */
 
 /**
@@ -3642,6 +3660,7 @@ class CartPlatformModel {
       uid: Joi.string().allow(""),
       gift_card: Joi.object().pattern(/\S/, Joi.any()),
       product_group_tags: Joi.array().items(Joi.string().allow("")),
+      force_new_line_item: Joi.boolean(),
       identifier: Joi.object().pattern(/\S/, Joi.any()),
       mto_quantity: Joi.number(),
       extra_meta: Joi.object().pattern(/\S/, Joi.any()),
@@ -3651,6 +3670,7 @@ class CartPlatformModel {
       meta: Joi.object().pattern(/\S/, Joi.any()),
       size: Joi.string().allow(""),
       store: CartPlatformModel.StoreInfo(),
+      item_index: Joi.number(),
       tags: Joi.array().items(Joi.string().allow("")),
     });
   }
@@ -4184,6 +4204,7 @@ class CartPlatformModel {
       item_id: Joi.number(),
       extra_meta: Joi.object().pattern(/\S/, Joi.any()),
       _custom_json: Joi.object().pattern(/\S/, Joi.any()),
+      force_new_line_item: Joi.boolean(),
       meta: Joi.object().pattern(/\S/, Joi.any()),
       pos: Joi.boolean(),
       seller_identifier: Joi.string().allow(""),
@@ -4230,6 +4251,7 @@ class CartPlatformModel {
       meta: Joi.object().pattern(/\S/, Joi.any()),
       extra_meta: Joi.object().pattern(/\S/, Joi.any()),
       _custom_json: Joi.object().pattern(/\S/, Joi.any()),
+      force_new_line_item: Joi.boolean(),
       item_id: Joi.number(),
       item_index: Joi.number(),
       identifiers: CartPlatformModel.CartProductIdentifer().required(),
@@ -4504,10 +4526,18 @@ class CartPlatformModel {
     });
   }
 
+  /** @returns {DiscountRules} */
+  static DiscountRules() {
+    return Joi.object({
+      discounted_price: Joi.number(),
+    });
+  }
+
   /** @returns {Coupon} */
   static Coupon() {
     return Joi.object({
       title: Joi.string().allow(""),
+      rule: Joi.array().items(CartPlatformModel.DiscountRules()),
       max_discount_value: Joi.number(),
       coupon_code: Joi.string().allow(""),
       is_applied: Joi.boolean(),
@@ -4713,6 +4743,7 @@ class CartPlatformModel {
       quantity: Joi.number(),
       shipment_type: Joi.string().allow("").required(),
       article_uid: Joi.string().allow("").required(),
+      item_index: Joi.number(),
     });
   }
 
@@ -4982,6 +5013,7 @@ class CartPlatformModel {
       type: Joi.string().allow(""),
       payment_identifier: Joi.string().allow("").allow(null),
       merchant_code: Joi.string().allow(""),
+      payment_source_bag_id: Joi.array().items(Joi.string().allow("")),
     });
   }