@gofynd/fdk-client-javascript 3.4.0 → 3.4.1

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

@@ -321,6 +321,57 @@ export = CartPlatformModel;
  *   which promotion is not applicable
  * @property {string[]} [item_sku] - List of all item sku on which promotion is applicable
  */
+/**
+ * @typedef BuyRuleItemCriteria
+ * @property {CompareObject} [cart_quantity]
+ * @property {string[]} [available_zones] - List of all zones on which promotion
+ *   is applicable
+ * @property {number[]} [item_exclude_company] - List of all company id on which
+ *   promotion is not applicable
+ * @property {number[]} [item_id] - List of all item ids on which promotion is applicable
+ * @property {number[]} [item_l1_category] - List of all L1 category on which
+ *   promotion is applicable
+ * @property {CompareObject} [cart_total]
+ * @property {CompareObject} [cart_unique_item_quantity]
+ * @property {CompareObject} [cart_unique_item_amount]
+ * @property {number[]} [item_exclude_id] - List of all item ids on which
+ *   promotion is not applicable
+ * @property {boolean} [all_items] - Boolean flag set true to applicable the
+ *   promotion for all products
+ * @property {number[]} [item_exclude_l1_category] - List of all item ids on
+ *   which promotion is not applicable
+ * @property {string[]} [item_size] - List of all item sizes on which promotion
+ *   is applicable
+ * @property {number[]} [item_store] - List of all item store ids on which
+ *   promotion is applicable
+ * @property {string[]} [item_exclude_sku] - List of all item sku on which
+ *   promotion is not applicable
+ * @property {number[]} [item_department] - List of all departments ids on which
+ *   promotion is applicable
+ * @property {number[]} [item_exclude_store] - List of all item store ids on
+ *   which promotion is not applicable
+ * @property {number[]} [item_brand] - List of all brand ids on which promotion
+ *   is applicable
+ * @property {number[]} [item_exclude_department] - List of all department ids
+ *   on which promotion is not applicable
+ * @property {number[]} [item_exclude_category] - List of all L3 category on
+ *   which promotion is not applicable
+ * @property {number[]} [item_category] - List of all L3 category on which
+ *   promotion is applicable
+ * @property {string[]} [buy_rules]
+ * @property {number[]} [item_exclude_brand] - List of all brand ids on which
+ *   promotion is not applicable
+ * @property {number[]} [item_l2_category] - List of all L2 category on which
+ *   promotion is applicable
+ * @property {number[]} [item_company] - List of all company ids on which
+ *   promotion is applicable
+ * @property {string[]} [item_tags] - List of all product tags on which
+ *   promotion is applicable
+ * @property {number[]} [item_exclude_l2_category] - List of all L2 category on
+ *   which promotion is not applicable
+ * @property {string[]} [item_sku] - List of all item sku on which promotion is applicable
+ * @property {ItemSizeMapping} [meta]
+ */
 /**
  * @typedef DiscountOffer
  * @property {number} [max_discount_amount] - Maximum discount amount in promotion
@@ -495,7 +546,7 @@ export = CartPlatformModel;
  * @property {PromotionAuthor} [author]
  * @property {Visibility} [visiblility]
  * @property {string} application_id - Current application id of sales channel
- * @property {ItemCriteria} [buy_rules]
+ * @property {BuyRuleItemCriteria} [buy_rules]
  * @property {Object} [_custom_json] - Set extra properties in promotion
  * @property {PromotionDateMeta} [date_meta]
  * @property {string[]} [tags] - List of tags applicable for promotion
@@ -599,7 +650,7 @@ export = CartPlatformModel;
  * @property {PromotionAuthor} [author]
  * @property {Visibility} [visiblility]
  * @property {string} application_id - Current application id of sales channel
- * @property {ItemCriteria} [buy_rules]
+ * @property {BuyRuleItemCriteria} [buy_rules]
  * @property {Object} [_custom_json] - Set extra properties in promotion
  * @property {PromotionDateMeta} [date_meta]
  * @property {string[]} [tags] - List of tags applicable for promotion
@@ -1199,7 +1250,7 @@ export = CartPlatformModel;
  * @property {string} [state] - State of the address
  * @property {string} [city] - City of the address
  * @property {number} [phone] - Phone number for address
- * @property {string} area_code - Area code of the address
+ * @property {string} [area_code] - Area code of the address
  * @property {string} [country_iso_code] - Country iso code for address
  * @property {string} [country_phone_code] - Country phone code for address
  * @property {Object} [meta] - Metadata of the address
@@ -1708,7 +1759,8 @@ export = CartPlatformModel;
  */
 /**
  * @typedef UpdateUserCartMapping
- * @property {string} user_id - User Id of user for which we map with the cart
+ * @property {string} [user_id] - Customer user ID to associate with the cart.
+ *   Send null to remove existing mapping of customer from cart.
  */
 /**
  * @typedef UserInfo
@@ -2401,14 +2453,93 @@ export = CartPlatformModel;
  *   | "kiosk"
  *   | "scan_go"
  *   | "smart_trolley"
+ *   | "gofynd"
+ *   | "uniket"
  *   | "marketplace"
  *   | "social_commerce"
- *   | "ondc"} OrderingSource
+ *   | "ondc"
+ *   | "nexus"
+ *   | "nykaa_fashion"
+ *   | "etsy"
+ *   | "vuivui"
+ *   | "zilingo"
+ *   | "firstcry"
+ *   | "bukalapak"
+ *   | "myntra_ppmp"
+ *   | "lazada"
+ *   | "tiktok"
+ *   | "sfcc"
+ *   | "debenhams"
+ *   | "prestomall"
+ *   | "meesho"
+ *   | "amazon_vdf"
+ *   | "bigcommerce"
+ *   | "sendo"
+ *   | "storehippo"
+ *   | "cdiscount"
+ *   | "nykaa"
+ *   | "trendyol"
+ *   | "weloveshopping"
+ *   | "jollee"
+ *   | "wish"
+ *   | "tiki"
+ *   | "central_online"
+ *   | "q10"
+ *   | "cred"
+ *   | "walmart"
+ *   | "snapdeal"
+ *   | "flipkart"
+ *   | "blibli"
+ *   | "ajio_jit"
+ *   | "pharmeasy"
+ *   | "ezmall"
+ *   | "adobe_commerce"
+ *   | "kartmax"
+ *   | "shopee"
+ *   | "zalora"
+ *   | "prestashop"
+ *   | "smytten"
+ *   | "amazon_sc"
+ *   | "urbanpiper"
+ *   | "flipkart_quick"
+ *   | "woocommerce"
+ *   | "zivame"
+ *   | "lelong"
+ *   | "facebook"
+ *   | "jiomart"
+ *   | "gmc"
+ *   | "robins"
+ *   | "akulaku"
+ *   | "noon"
+ *   | "tatacliq"
+ *   | "kartrocket"
+ *   | "inorbit"
+ *   | "ajio_business"
+ *   | "swiggy"
+ *   | "asos"
+ *   | "tokopedia"
+ *   | "limeroad"
+ *   | "myntra_omni"
+ *   | "spoyl"
+ *   | "amazon_mlf"
+ *   | "fulfilled_by_lazada"
+ *   | "ebay"
+ *   | "jd"
+ *   | "amazon_pharmacy"
+ *   | "ajio_vms"
+ *   | "daraz"
+ *   | "oker"
+ *   | "flipkart_b2b"
+ *   | "amazon_mlf_ss"
+ *   | "woovly"
+ *   | "tata1mg"
+ *   | "zomato"
+ *   | "shopify"} OrderingSource
  */
 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, FulfillmentOptionSchema, StoreTimingSchema, StoreHoursSchema, PickupStoreDetailSchema, 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, PlatformAlternatePickupPerson, 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 };
+    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, BuyRuleItemCriteria, 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, FulfillmentOptionSchema, StoreTimingSchema, StoreHoursSchema, PickupStoreDetailSchema, 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, PlatformAlternatePickupPerson, 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;
@@ -3180,6 +3311,124 @@ type ItemCriteria = {
      */
     item_sku?: string[];
 };
+/** @returns {BuyRuleItemCriteria} */
+declare function BuyRuleItemCriteria(): BuyRuleItemCriteria;
+type BuyRuleItemCriteria = {
+    cart_quantity?: CompareObject;
+    /**
+     * - List of all zones on which promotion
+     * is applicable
+     */
+    available_zones?: string[];
+    /**
+     * - List of all company id on which
+     * promotion is not applicable
+     */
+    item_exclude_company?: number[];
+    /**
+     * - List of all item ids on which promotion is applicable
+     */
+    item_id?: number[];
+    /**
+     * - List of all L1 category on which
+     * promotion is applicable
+     */
+    item_l1_category?: number[];
+    cart_total?: CompareObject;
+    cart_unique_item_quantity?: CompareObject;
+    cart_unique_item_amount?: CompareObject;
+    /**
+     * - List of all item ids on which
+     * promotion is not applicable
+     */
+    item_exclude_id?: number[];
+    /**
+     * - Boolean flag set true to applicable the
+     * promotion for all products
+     */
+    all_items?: boolean;
+    /**
+     * - List of all item ids on
+     * which promotion is not applicable
+     */
+    item_exclude_l1_category?: number[];
+    /**
+     * - List of all item sizes on which promotion
+     * is applicable
+     */
+    item_size?: string[];
+    /**
+     * - List of all item store ids on which
+     * promotion is applicable
+     */
+    item_store?: number[];
+    /**
+     * - List of all item sku on which
+     * promotion is not applicable
+     */
+    item_exclude_sku?: string[];
+    /**
+     * - List of all departments ids on which
+     * promotion is applicable
+     */
+    item_department?: number[];
+    /**
+     * - List of all item store ids on
+     * which promotion is not applicable
+     */
+    item_exclude_store?: number[];
+    /**
+     * - List of all brand ids on which promotion
+     * is applicable
+     */
+    item_brand?: number[];
+    /**
+     * - List of all department ids
+     * on which promotion is not applicable
+     */
+    item_exclude_department?: number[];
+    /**
+     * - List of all L3 category on
+     * which promotion is not applicable
+     */
+    item_exclude_category?: number[];
+    /**
+     * - List of all L3 category on which
+     * promotion is applicable
+     */
+    item_category?: number[];
+    buy_rules?: string[];
+    /**
+     * - List of all brand ids on which
+     * promotion is not applicable
+     */
+    item_exclude_brand?: number[];
+    /**
+     * - List of all L2 category on which
+     * promotion is applicable
+     */
+    item_l2_category?: number[];
+    /**
+     * - List of all company ids on which
+     * promotion is applicable
+     */
+    item_company?: number[];
+    /**
+     * - List of all product tags on which
+     * promotion is applicable
+     */
+    item_tags?: string[];
+    /**
+     * - List of all L2 category on
+     * which promotion is not applicable
+     */
+    item_exclude_l2_category?: number[];
+    /**
+     * - List of all item sku on which promotion is applicable
+     */
+    item_sku?: string[];
+    meta?: ItemSizeMapping;
+};
 /** @returns {DiscountOffer} */
 declare function DiscountOffer(): DiscountOffer;
 type DiscountOffer = {
@@ -3605,7 +3854,7 @@ type PromotionAdd = {
      * - Current application id of sales channel
      */
     application_id: string;
-    buy_rules?: ItemCriteria;
+    buy_rules?: BuyRuleItemCriteria;
     /**
      * - Set extra properties in promotion
      */
@@ -3859,7 +4108,7 @@ type PromotionUpdateResult = {
      * - Current application id of sales channel
      */
     application_id: string;
-    buy_rules?: ItemCriteria;
+    buy_rules?: BuyRuleItemCriteria;
     /**
      * - Set extra properties in promotion
      */
@@ -5337,7 +5586,7 @@ type ShippingAddress = {
     /**
      * - Area code of the address
      */
-    area_code: string;
+    area_code?: string;
     /**
      * - Country iso code for address
      */
@@ -6702,9 +6951,10 @@ type MultiCartResult = {
 declare function UpdateUserCartMapping(): UpdateUserCartMapping;
 type UpdateUserCartMapping = {
     /**
-     * - User Id of user for which we map with the cart
+     * - Customer user ID to associate with the cart.
+     * Send null to remove existing mapping of customer from cart.
      */
-    user_id: string;
+    user_id?: string;
 };
 /** @returns {UserInfo} */
 declare function UserInfo(): UserInfo;
@@ -8437,4 +8687,4 @@ type ValidationError = {
  * @returns {OrderingSource}
  */
 declare function OrderingSource(): OrderingSource;
-type OrderingSource = "storefront" | "store_os_pos" | "kiosk" | "scan_go" | "smart_trolley" | "marketplace" | "social_commerce" | "ondc";
+type OrderingSource = "storefront" | "store_os_pos" | "kiosk" | "scan_go" | "smart_trolley" | "gofynd" | "uniket" | "marketplace" | "social_commerce" | "ondc" | "nexus" | "nykaa_fashion" | "etsy" | "vuivui" | "zilingo" | "firstcry" | "bukalapak" | "myntra_ppmp" | "lazada" | "tiktok" | "sfcc" | "debenhams" | "prestomall" | "meesho" | "amazon_vdf" | "bigcommerce" | "sendo" | "storehippo" | "cdiscount" | "nykaa" | "trendyol" | "weloveshopping" | "jollee" | "wish" | "tiki" | "central_online" | "q10" | "cred" | "walmart" | "snapdeal" | "flipkart" | "blibli" | "ajio_jit" | "pharmeasy" | "ezmall" | "adobe_commerce" | "kartmax" | "shopee" | "zalora" | "prestashop" | "smytten" | "amazon_sc" | "urbanpiper" | "flipkart_quick" | "woocommerce" | "zivame" | "lelong" | "facebook" | "jiomart" | "gmc" | "robins" | "akulaku" | "noon" | "tatacliq" | "kartrocket" | "inorbit" | "ajio_business" | "swiggy" | "asos" | "tokopedia" | "limeroad" | "myntra_omni" | "spoyl" | "amazon_mlf" | "fulfilled_by_lazada" | "ebay" | "jd" | "amazon_pharmacy" | "ajio_vms" | "daraz" | "oker" | "flipkart_b2b" | "amazon_mlf_ss" | "woovly" | "tata1mg" | "zomato" | "shopify";