@gofynd/fdk-client-javascript 3.12.0 → 3.14.0

package/README.md

@@ -234,7 +234,7 @@ console.log("Active Theme: ", response.information.name);
 The above code will log the curl command in the console
 
 ```bash
-curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.12.0' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
+curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.14.0' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
 Active Theme: Emerge
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gofynd/fdk-client-javascript",
-  "version": "3.12.0",
+  "version": "3.14.0",
   "description": "",
   "main": "index.js",
   "scripts": {

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

@@ -434,7 +434,7 @@ declare class Cart {
      * @returns {Promise<CartPlatformModel.AddCartDetailResult>} - Success response
      * @name platformAddItems
      * @summary: Add items to cart
-     * @description: Add product items to the customer's existing shopping cart. If there is no existing cart associated with the customer, it creates a new one and adds the items to it. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/platformAddItems/).
+     * @description: Adds product items to a customer's shopping cart. If the customer does not have an existing cart, a new one is created automatically. - The `new_cart` flag forces creation of a new cart even if one already exists. - The `default_cart` flag determines whether the item is added to the user's default storefront-visible cart. If `true`, the item is added to the user's default cart that is accessible via the storefront. If `false`, an existing active cart is fetched if available; otherwise, a new hidden cart is created. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/platformAddItems/).
      */
     platformAddItems({ body, xOrderingSource, i, b, buyNow, orderType, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformAddItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.AddCartDetailResult>;
     /**

package/sdk/platform/Cart/CartPlatformApplicationClient.js

@@ -3558,7 +3558,7 @@ class Cart {
    * @returns {Promise<CartPlatformModel.AddCartDetailResult>} - Success response
    * @name platformAddItems
    * @summary: Add items to cart
-   * @description: Add product items to the customer's existing shopping cart. If there is no existing cart associated with the customer, it creates a new one and adds the items to it. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/platformAddItems/).
+   * @description: Adds product items to a customer's shopping cart. If the customer does not have an existing cart, a new one is created automatically. - The `new_cart` flag forces creation of a new cart even if one already exists. - The `default_cart` flag determines whether the item is added to the user's default storefront-visible cart. If `true`, the item is added to the user's default cart that is accessible via the storefront. If `false`, an existing active cart is fetched if available; otherwise, a new hidden cart is created. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/platformAddItems/).
    */
   async platformAddItems(
     { body, xOrderingSource, i, b, buyNow, orderType, id, requestHeaders } = {

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

@@ -1884,10 +1884,15 @@ export = CartPlatformModel;
  */
 /**
  * @typedef PlatformAddCartDetails
- * @property {string} [user_id] - The user id of user, for which we need to add
- *   item into cart
- * @property {boolean} [new_cart] - Field to create to new cart whille user adds
- *   item to cart
+ * @property {string} [user_id] - The unique identifier of the user for whom
+ *   items are being added to the cart
+ * @property {boolean} [new_cart] - Indicates whether a new cart should be
+ *   created. If `true`, a new cart is created even if one already exists.
+ * @property {boolean} [default_cart] - Determines whether the item is added to
+ *   the user's default visible cart on the storefront. If `true`, the item is
+ *   added to the user's default cart that is accessible via the storefront. If
+ *   `false`, an existing active cart is fetched if available; otherwise, a new
+ *   hidden cart is created. Defaults to `true`.
  * @property {AddProductCart[]} [items] - List of items detail which need to be
  *   added to cart like item id, item size, and item quantity
  */
@@ -7278,15 +7283,23 @@ type UserCartMappingResult = {
 declare function PlatformAddCartDetails(): PlatformAddCartDetails;
 type PlatformAddCartDetails = {
     /**
-     * - The user id of user, for which we need to add
-     * item into cart
+     * - The unique identifier of the user for whom
+     * items are being added to the cart
      */
     user_id?: string;
     /**
-     * - Field to create to new cart whille user adds
-     * item to cart
+     * - Indicates whether a new cart should be
+     * created. If `true`, a new cart is created even if one already exists.
      */
     new_cart?: boolean;
+    /**
+     * - Determines whether the item is added to
+     * the user's default visible cart on the storefront. If `true`, the item is
+     * added to the user's default cart that is accessible via the storefront. If
+     * `false`, an existing active cart is fetched if available; otherwise, a new
+     * hidden cart is created. Defaults to `true`.
+     */
+    default_cart?: boolean;
     /**
      * - List of items detail which need to be
      * added to cart like item id, item size, and item quantity

package/sdk/platform/Cart/CartPlatformModel.js

@@ -2046,10 +2046,15 @@ const Joi = require("joi");
 
 /**
  * @typedef PlatformAddCartDetails
- * @property {string} [user_id] - The user id of user, for which we need to add
- *   item into cart
- * @property {boolean} [new_cart] - Field to create to new cart whille user adds
- *   item to cart
+ * @property {string} [user_id] - The unique identifier of the user for whom
+ *   items are being added to the cart
+ * @property {boolean} [new_cart] - Indicates whether a new cart should be
+ *   created. If `true`, a new cart is created even if one already exists.
+ * @property {boolean} [default_cart] - Determines whether the item is added to
+ *   the user's default visible cart on the storefront. If `true`, the item is
+ *   added to the user's default cart that is accessible via the storefront. If
+ *   `false`, an existing active cart is fetched if available; otherwise, a new
+ *   hidden cart is created. Defaults to `true`.
  * @property {AddProductCart[]} [items] - List of items detail which need to be
  *   added to cart like item id, item size, and item quantity
  */
@@ -4836,6 +4841,7 @@ class CartPlatformModel {
     return Joi.object({
       user_id: Joi.string().allow(""),
       new_cart: Joi.boolean(),
+      default_cart: Joi.boolean(),
       items: Joi.array().items(CartPlatformModel.AddProductCart()),
     });
   }

package/sdk/platform/Catalog/CatalogPlatformModel.js

@@ -6643,7 +6643,7 @@ class CatalogPlatformModel {
       departments: Joi.array().items(Joi.number()),
       description: Joi.string().allow(""),
       highlights: Joi.array().items(Joi.string().allow("")),
-      hs_code: Joi.string().allow(""),
+      hs_code: Joi.string().allow("").allow(null),
       hsn_code: Joi.string().allow(""),
       id: Joi.string().allow(""),
       image_nature: Joi.string().allow(""),
@@ -8402,7 +8402,7 @@ class CatalogPlatformModel {
       departments: Joi.array().items(Joi.number()),
       description: Joi.string().allow(""),
       highlights: Joi.array().items(Joi.string().allow("")),
-      hs_code: Joi.string().allow(""),
+      hs_code: Joi.string().allow("").allow(null),
       hsn_code: Joi.string().allow(""),
       id: Joi.string().allow(""),
       image_nature: Joi.string().allow(""),
@@ -8562,7 +8562,7 @@ class CatalogPlatformModel {
       variant_group: Joi.object().pattern(/\S/, Joi.any()),
       variant_media: Joi.object().pattern(/\S/, Joi.any()),
       variants: Joi.object().pattern(/\S/, Joi.any()),
-      hs_code: Joi.string().allow(""),
+      hs_code: Joi.string().allow("").allow(null),
       bundle_details: Joi.array()
         .items(CatalogPlatformModel.BundleDetails())
         .allow(null, ""),
@@ -8609,7 +8609,7 @@ class CatalogPlatformModel {
       slug: Joi.string().allow("").required(),
       tags: Joi.array().items(Joi.string().allow("")),
       tax_identifier: CatalogPlatformModel.TaxIdentifierV3().required(),
-      hs_code: Joi.string().allow(""),
+      hs_code: Joi.string().allow("").allow(null),
       teaser_tag: CatalogPlatformModel.TeaserTag(),
       template_tag: Joi.string().allow("").required(),
       trader: Joi.array().items(CatalogPlatformModel.Trader()).required(),
@@ -8645,7 +8645,7 @@ class CatalogPlatformModel {
       sizes: Joi.array().items(CatalogPlatformModel.ProductSizePatch()),
       tags: Joi.array().items(Joi.string().allow("")),
       tax_identifier: CatalogPlatformModel.TaxIdentifierV3(),
-      hs_code: Joi.string().allow(""),
+      hs_code: Joi.string().allow("").allow(null),
       teaser_tag: CatalogPlatformModel.TeaserTag(),
       template_tag: Joi.string().allow(""),
       trader: Joi.array().items(CatalogPlatformModel.Trader()),
@@ -9140,7 +9140,7 @@ class CatalogPlatformModel {
       departments: Joi.array().items(Joi.number()),
       description: Joi.string().allow(""),
       highlights: Joi.array().items(Joi.string().allow("")),
-      hs_code: Joi.string().allow(""),
+      hs_code: Joi.string().allow("").allow(null),
       hsn_code: Joi.string().allow(""),
       id: Joi.string().allow(""),
       image_nature: Joi.string().allow(""),
@@ -9343,7 +9343,7 @@ class CatalogPlatformModel {
       custom_order: Joi.object().pattern(/\S/, Joi.any()),
       description: Joi.object().pattern(/\S/, Joi.any()),
       highlights: Joi.object().pattern(/\S/, Joi.any()),
-      hs_code: Joi.object().pattern(/\S/, Joi.any()),
+      hs_code: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
       hsn_code: Joi.object().pattern(/\S/, Joi.any()),
       is_active: Joi.object().pattern(/\S/, Joi.any()),
       is_dependent: Joi.object().pattern(/\S/, Joi.any()),

package/sdk/platform/Order/OrderPlatformClient.d.ts

@@ -85,7 +85,7 @@ declare class Order {
      * @returns {Promise<Object>} - Success response
      * @name createOrder
      * @summary: Create Order
-     * @description: Creates an order in the OMS. Note: Use the Serviceability API (getShipments) to determine shipments before creating an order. OMS no longer auto-selects fulfillment stores and only creates shipments as provided in the request payload. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createOrder/).
+     * @description: Creates an order in the OMS. Note: Use the Serviceability API (<a href='/commerce/sdk/latest/platform/company/serviceability#createShipments'>createShipments</a>) to determine shipments before creating an order. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createOrder/).
      */
     createOrder({ xOrderingSource, body, xApplicationId, xExtensionId, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<any>;
     /**

package/sdk/platform/Order/OrderPlatformClient.js

@@ -604,7 +604,7 @@ class Order {
    * @returns {Promise<Object>} - Success response
    * @name createOrder
    * @summary: Create Order
-   * @description: Creates an order in the OMS. Note: Use the Serviceability API (getShipments) to determine shipments before creating an order. OMS no longer auto-selects fulfillment stores and only creates shipments as provided in the request payload. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createOrder/).
+   * @description: Creates an order in the OMS. Note: Use the Serviceability API (<a href='/commerce/sdk/latest/platform/company/serviceability#createShipments'>createShipments</a>) to determine shipments before creating an order. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createOrder/).
    */
   async createOrder(
     { xOrderingSource, body, xApplicationId, xExtensionId, requestHeaders } = {