@gofynd/fdk-client-javascript 3.10.0 → 3.12.0

package/sdk/platform/Cart/CartPlatformModel.js

@@ -367,8 +367,8 @@ const Joi = require("joi");
  * @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_exclude_company] - List of all company ids 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
@@ -389,8 +389,8 @@ const Joi = require("joi");
  *   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_exclude_store] - List of all 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
@@ -414,10 +414,47 @@ const Joi = require("joi");
  * @property {ItemSizeMapping} [meta]
  */
 
+/**
+ * @typedef DiscountItemCriteria
+ * @property {number[]} [item_store] - List of all store ids on which promotion
+ *   is applicable
+ * @property {number[]} [item_company] - List of all company ids on which
+ *   promotion is applicable
+ * @property {number[]} [item_brand] - List of all brand ids on which promotion
+ *   is applicable
+ * @property {number[]} [item_exclude_brand] - List of all brand ids on which
+ *   promotion is not applicable
+ * @property {number[]} [item_category] - List of all L3 category on which
+ *   promotion is applicable
+ * @property {number[]} [item_exclude_category] - List of all L3 category on
+ *   which promotion is not applicable
+ * @property {number[]} [item_l1_category] - List of all L1 category on which
+ *   promotion is applicable
+ * @property {number[]} [item_exclude_l1_category] - List of all item 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_exclude_l2_category] - List of all L2 category on
+ *   which promotion is not applicable
+ * @property {number[]} [item_department] - List of all departments 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_id] - List of all item ids on which promotion is applicable
+ * @property {number[]} [item_exclude_id] - List of all item ids on which
+ *   promotion is not applicable
+ * @property {string[]} [buy_rules] - Buy rules that apply to this discount
+ * @property {string[]} [available_zones] - List of all zones ids on which
+ *   promotion is applicable
+ * @property {string[]} [product_tags] - Product tags that qualify for the discount
+ * @property {boolean} [all_items] - Whether the discount applies to all items
+ */
+
 /**
  * @typedef DiscountOffer
  * @property {number} [max_discount_amount] - Maximum discount amount in promotion
- * @property {number} [discount_price] - Discount price in promotion
+ * @property {number} [discount_price] - Discount price which is price after
+ *   deducting discount amount in fixed price promotion
  * @property {boolean} [apportion_discount] - Flag to distribute discount for each article
  * @property {boolean} [partial_can_ret] - Flag indicated return the product partially
  * @property {number} [max_usage_per_transaction] - Maximum usage per
@@ -427,6 +464,8 @@ const Joi = require("joi");
  * @property {number} [discount_amount] - Discount amount in promotion
  * @property {number} [discount_percentage] - Discount percentage in promotion
  * @property {number} [max_offer_quantity] - Maximum quantity of product in promotion
+ * @property {number} [item_sequence_number] - Cart sequence number of item for
+ *   which offer is valid
  */
 
 /**
@@ -1366,6 +1405,7 @@ const Joi = require("joi");
  * @property {ProductPriceInfo} [price_per_unit]
  * @property {PromoMeta} [promo_meta]
  * @property {Object} [custom_order] - Whether MTO (Make to Order) is enabled or not.
+ * @property {string} [item_type] - Type of the item in cart.
  */
 
 /**
@@ -2649,17 +2689,31 @@ const Joi = require("joi");
  * @property {string[]} [item_images_url] - List of free gift product images URL
  */
 
+/**
+ * @typedef DiscountOfferRule
+ * @property {string} [discount_type] - Discount offer type of the promotion
+ * @property {DiscountOffer} [offer]
+ * @property {DiscountItemCriteria} [item_criteria]
+ * @property {string} [buy_condition] - Logical condition expression for buy rules
+ * @property {number} [discounted_price] - Price of product after applying this
+ *   discount rule of promotion. Note - returned only when store id is provided
+ *   in request params.
+ * @property {string[]} [matched_buy_rules] - List of buy rules that are
+ *   matching with item for this promotion
+ * @property {ItemSizeMapping} [meta]
+ */
+
 /**
  * @typedef PromotionOffer
  * @property {string} [id] - Promotion unique identifier
- * @property {Object} [buy_rules] - Buy rules of promotions
+ * @property {BuyRuleItemCriteria} [buy_rules]
  * @property {string} [offer_text] - Offer title of promotion that used to display
  * @property {string} [promotion_type] - Type of Promotion like percentage,
  *   amount, bogo etc.
  * @property {string} [promotion_name] - Name of the promotion
  * @property {string} [promotion_group] - Group of promotion belongs to
  * @property {string} [valid_till] - Datetime ISOString for promotion end date
- * @property {Object[]} [discount_rules] - Discount rules of promotions
+ * @property {DiscountOfferRule[]} [discount_rules] - Discount rules of promotions
  * @property {FreeGiftItems[]} [free_gift_items] - Details of free gift items
  * @property {string} [description] - Offer details including T&C
  */
@@ -2697,17 +2751,6 @@ const Joi = require("joi");
  * @property {string} field - The field in the request that caused the error.
  */
 
-/**
- * @typedef {| "storefront"
- *   | "store_os_pos"
- *   | "kiosk"
- *   | "scan_go"
- *   | "smart_trolley"
- *   | "marketplace"
- *   | "social_commerce"
- *   | "ondc"} OrderingSource
- */
-
 class CartPlatformModel {
   /** @returns {RedeemLoyaltyPoints} */
   static RedeemLoyaltyPoints() {
@@ -3137,6 +3180,30 @@ class CartPlatformModel {
     });
   }
 
+  /** @returns {DiscountItemCriteria} */
+  static DiscountItemCriteria() {
+    return Joi.object({
+      item_store: Joi.array().items(Joi.number()),
+      item_company: Joi.array().items(Joi.number()),
+      item_brand: Joi.array().items(Joi.number()),
+      item_exclude_brand: Joi.array().items(Joi.number()),
+      item_category: Joi.array().items(Joi.number()),
+      item_exclude_category: Joi.array().items(Joi.number()),
+      item_l1_category: Joi.array().items(Joi.number()),
+      item_exclude_l1_category: Joi.array().items(Joi.number()),
+      item_l2_category: Joi.array().items(Joi.number()),
+      item_exclude_l2_category: Joi.array().items(Joi.number()),
+      item_department: Joi.array().items(Joi.number()),
+      item_exclude_department: Joi.array().items(Joi.number()),
+      item_id: Joi.array().items(Joi.number()),
+      item_exclude_id: Joi.array().items(Joi.number()),
+      buy_rules: Joi.array().items(Joi.string().allow("")),
+      available_zones: Joi.array().items(Joi.string().allow("")),
+      product_tags: Joi.array().items(Joi.string().allow("")),
+      all_items: Joi.boolean(),
+    });
+  }
+
   /** @returns {DiscountOffer} */
   static DiscountOffer() {
     return Joi.object({
@@ -3144,12 +3211,13 @@ class CartPlatformModel {
       discount_price: Joi.number(),
       apportion_discount: Joi.boolean(),
       partial_can_ret: Joi.boolean(),
-      max_usage_per_transaction: Joi.number().allow(null),
+      max_usage_per_transaction: Joi.number(),
       min_offer_quantity: Joi.number(),
       code: Joi.string().allow(""),
       discount_amount: Joi.number(),
       discount_percentage: Joi.number(),
       max_offer_quantity: Joi.number(),
+      item_sequence_number: Joi.number(),
     });
   }
 
@@ -4118,6 +4186,7 @@ class CartPlatformModel {
       price_per_unit: CartPlatformModel.ProductPriceInfo(),
       promo_meta: CartPlatformModel.PromoMeta(),
       custom_order: Joi.object().pattern(/\S/, Joi.any()),
+      item_type: Joi.string().allow(""),
     });
   }
 
@@ -5408,17 +5477,30 @@ class CartPlatformModel {
     });
   }
 
+  /** @returns {DiscountOfferRule} */
+  static DiscountOfferRule() {
+    return Joi.object({
+      discount_type: Joi.string().allow(""),
+      offer: CartPlatformModel.DiscountOffer(),
+      item_criteria: CartPlatformModel.DiscountItemCriteria(),
+      buy_condition: Joi.string().allow(""),
+      discounted_price: Joi.number(),
+      matched_buy_rules: Joi.array().items(Joi.string().allow("")),
+      meta: CartPlatformModel.ItemSizeMapping(),
+    });
+  }
+
   /** @returns {PromotionOffer} */
   static PromotionOffer() {
     return Joi.object({
       id: Joi.string().allow(""),
-      buy_rules: Joi.object().pattern(/\S/, Joi.any()),
+      buy_rules: CartPlatformModel.BuyRuleItemCriteria(),
       offer_text: Joi.string().allow(""),
       promotion_type: Joi.string().allow(""),
       promotion_name: Joi.string().allow(""),
       promotion_group: Joi.string().allow(""),
       valid_till: Joi.string().allow(""),
-      discount_rules: Joi.array().items(Joi.any()),
+      discount_rules: Joi.array().items(CartPlatformModel.DiscountOfferRule()),
       free_gift_items: Joi.array().items(CartPlatformModel.FreeGiftItems()),
       description: Joi.string().allow(""),
     });
@@ -5464,30 +5546,5 @@ class CartPlatformModel {
       field: Joi.string().allow("").required(),
     });
   }
-
-  /**
-   * Enum: OrderingSource Used By: Cart
-   *
-   * @returns {OrderingSource}
-   */
-  static OrderingSource() {
-    return Joi.string().valid(
-      "storefront",
-
-      "store_os_pos",
-
-      "kiosk",
-
-      "scan_go",
-
-      "smart_trolley",
-
-      "marketplace",
-
-      "social_commerce",
-
-      "ondc"
-    );
-  }
 }
 module.exports = CartPlatformModel;

package/sdk/platform/Catalog/CatalogPlatformClient.d.ts

@@ -126,18 +126,6 @@ declare class Catalog {
      * @description: Helps to create a bulk asset upload job. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createProductAssetsInBulk/).
      */
     createProductAssetsInBulk({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
-    /**
-     * @param {CatalogPlatformValidator.CreateProductBundleParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>}
-     *   - Success response
-     *
-     * @name createProductBundle
-     * @summary: Create product bundle
-     * @description: Create product bundle in the catalog associated to a specific company - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/createProductBundle/).
-     */
-    createProductBundle({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>;
     /**
      * @param {CatalogPlatformValidator.CreateProductExportJobParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -694,30 +682,6 @@ declare class Catalog {
         search?: string;
         pageSize?: number;
     }): Paginator<CatalogPlatformModel.ProductBulkRequestList>;
-    /**
-     * @param {CatalogPlatformValidator.GetProductBundleParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CatalogPlatformModel.GetProductBundleListingResponseSchema>}
-     *   - Success response
-     *
-     * @name getProductBundle
-     * @summary: List product bundles
-     * @description: Retrieve a list of product bundles available in the catalog associated to a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductBundle/).
-     */
-    getProductBundle({ q, slug, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleListingResponseSchema>;
-    /**
-     * @param {CatalogPlatformValidator.GetProductBundleDetailParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CatalogPlatformModel.GetProductBundleResponseSchema>}
-     *   - Success response
-     *
-     * @name getProductBundleDetail
-     * @summary: Get product bundle
-     * @description: Retrieve detailed information about a specific product bundle associated to a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getProductBundleDetail/).
-     */
-    getProductBundleDetail({ id, requestHeaders }?: CatalogPlatformValidator.GetProductBundleDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleResponseSchema>;
     /**
      * @param {CatalogPlatformValidator.GetProductExportJobsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -1057,6 +1021,20 @@ declare class Catalog {
      * @description: Retrieve values related to template brand types for a specific company. The filter type query parameter defines what type of data to return.  - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/listTemplateBrandTypeValues/).
      */
     listTemplateBrandTypeValues({ filter, templateTag, itemType, requestHeaders }?: CatalogPlatformValidator.ListTemplateBrandTypeValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductConfigurationDownloads>;
+    /**
+     * @param {CatalogPlatformValidator.PartialUpdateProductParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
+     * @name partialUpdateProduct
+     * @summary: Patch a product
+     * @description: Partially update an existing product in the catalog using PATCH method. This operation allows you to modify specific fields of a product without affecting other attributes. Only the fields provided in the request body will be updated, while all other existing product data remains unchanged.
+     * For objects (e.g. attributes), merge keys shallowly: any key in the patch overrides the existing value.
+     * For arrays of primitives (e.g. tags): replaced wholesale when present.
+     * For arrays of objects (e.g. sizes): match on a unique identifier (seller_identifier) and apply the merge-patch per element; unmentioned elements remain unchanged.
+     *  - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/partialUpdateProduct/).
+     */
+    partialUpdateProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.PartialUpdateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
     /**
      * @param {CatalogPlatformValidator.UpdateHsnCodeParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -1114,18 +1092,6 @@ declare class Catalog {
      * @description: Allows to update marketplace optin for a company by marketplace_slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateMarketplaceOptin/).
      */
     updateMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.UpdateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponseSchema>;
-    /**
-     * @param {CatalogPlatformValidator.UpdateProductBundleParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>}
-     *   - Success response
-     *
-     * @name updateProductBundle
-     * @summary: Update product bundle
-     * @description: Modify the details of an existing product bundle in the catalog associated to a specific company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/updateProductBundle/).
-     */
-    updateProductBundle({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>;
     /**
      * @param {CatalogPlatformValidator.UpdateRealtimeInventoryParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`