@gofynd/fdk-client-javascript 3.25.0 → 3.26.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.25.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.26.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.25.0",
+  "version": "3.26.0",
   "description": "",
   "main": "index.js",
   "scripts": {

package/sdk/application/Catalog/CatalogApplicationClient.d.ts

@@ -344,9 +344,9 @@ declare class Catalog {
      * @returns {Promise<ProductSizeSellersResponseV4>} - Success response
      * @name getProductSellersBySlug
      * @summary: List sellers
-     * @description: List all sellers offering a specific product identified by its slug and size. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductSellersBySlug/).
+     * @description: List all sellers offering a specific product identified by its slug and size. Optionally filter the seller list by store name, seller name, or store code using the `q` query parameter. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductSellersBySlug/).
      */
-    getProductSellersBySlug({ slug, size, strategy, fulfillmentOptionSlug, pageNo, pageSize, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizeSellersResponseV4>;
+    getProductSellersBySlug({ slug, size, strategy, fulfillmentOptionSlug, pageNo, pageSize, q, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizeSellersResponseV4>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.slug - A short, human-readable, URL-friendly
@@ -360,16 +360,19 @@ declare class Catalog {
      * @param {string} [arg.fulfillmentOptionSlug] - Specifies the fulfillment
      *   method, indicating whether an order is for home delivery or store pickup
      * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
+     * @param {string} [arg.q] - Filter sellers by matching text against store
+     *   name, seller name, or store code. Case-insensitive partial match.
      * @returns {Paginator<ProductSizeSellersResponseV4>}
      * @summary: List sellers
-     * @description: List all sellers offering a specific product identified by its slug and size.
+     * @description: List all sellers offering a specific product identified by its slug and size. Optionally filter the seller list by store name, seller name, or store code using the `q` query parameter.
      */
-    getProductSellersBySlugPaginator({ slug, size, strategy, fulfillmentOptionSlug, pageSize, }?: {
+    getProductSellersBySlugPaginator({ slug, size, strategy, fulfillmentOptionSlug, pageSize, q, }?: {
         slug: string;
         size: string;
         strategy?: string;
         fulfillmentOptionSlug?: string;
         pageSize?: number;
+        q?: string;
     }): Paginator<ProductSizeSellersResponseV4>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/application/Catalog/CatalogApplicationClient.js

@@ -1279,7 +1279,7 @@ class Catalog {
    * @returns {Promise<ProductSizeSellersResponseV4>} - Success response
    * @name getProductSellersBySlug
    * @summary: List sellers
-   * @description: List all sellers offering a specific product identified by its slug and size. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductSellersBySlug/).
+   * @description: List all sellers offering a specific product identified by its slug and size. Optionally filter the seller list by store name, seller name, or store code using the `q` query parameter. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductSellersBySlug/).
    */
   async getProductSellersBySlug(
     {
@@ -1289,6 +1289,7 @@ class Catalog {
       fulfillmentOptionSlug,
       pageNo,
       pageSize,
+      q,
       requestHeaders,
     } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
@@ -1307,6 +1308,7 @@ class Catalog {
     query_params["fulfillment_option_slug"] = fulfillmentOptionSlug;
     query_params["page_no"] = pageNo;
     query_params["page_size"] = pageSize;
+    query_params["q"] = q;
 
     const xHeaders = {};
 
@@ -1344,9 +1346,11 @@ class Catalog {
    * @param {string} [arg.fulfillmentOptionSlug] - Specifies the fulfillment
    *   method, indicating whether an order is for home delivery or store pickup
    * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
+   * @param {string} [arg.q] - Filter sellers by matching text against store
+   *   name, seller name, or store code. Case-insensitive partial match.
    * @returns {Paginator<ProductSizeSellersResponseV4>}
    * @summary: List sellers
-   * @description: List all sellers offering a specific product identified by its slug and size.
+   * @description: List all sellers offering a specific product identified by its slug and size. Optionally filter the seller list by store name, seller name, or store code using the `q` query parameter.
    */
   getProductSellersBySlugPaginator({
     slug,
@@ -1354,6 +1358,7 @@ class Catalog {
     strategy,
     fulfillmentOptionSlug,
     pageSize,
+    q,
   } = {}) {
     const paginator = new Paginator();
     const callback = async () => {
@@ -1367,6 +1372,7 @@ class Catalog {
         fulfillmentOptionSlug: fulfillmentOptionSlug,
         pageNo: pageNo,
         pageSize: pageSize,
+        q: q,
       });
       paginator.setPaginator({
         hasNext: data.page.has_next ? true : false,

package/sdk/partner/Theme/ThemePartnerModel.d.ts

@@ -656,6 +656,7 @@ export = ThemePartnerModel;
  *   | "profile-company"
  *   | "profile-email"
  *   | "profile-phone"
+ *   | "profile-loyalty-rewards"
  *   | "rate-us"
  *   | "refer-earn"
  *   | "settings"
@@ -1898,4 +1899,4 @@ type ActionPage = {
  * @returns {PageType}
  */
 declare function PageType(): PageType;
-type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt" | "files";
+type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "profile-loyalty-rewards" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt" | "files";

package/sdk/partner/Theme/ThemePartnerModel.js

@@ -748,6 +748,7 @@ const Joi = require("joi");
  *   | "profile-company"
  *   | "profile-email"
  *   | "profile-phone"
+ *   | "profile-loyalty-rewards"
  *   | "rate-us"
  *   | "refer-earn"
  *   | "settings"
@@ -1743,6 +1744,8 @@ class ThemePartnerModel {
 
       "profile-phone",
 
+      "profile-loyalty-rewards",
+
       "rate-us",
 
       "refer-earn",

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

@@ -4971,6 +4971,7 @@ export = CatalogPlatformModel;
  *   | "profile-company"
  *   | "profile-email"
  *   | "profile-phone"
+ *   | "profile-loyalty-rewards"
  *   | "rate-us"
  *   | "refer-earn"
  *   | "settings"
@@ -15640,4 +15641,4 @@ type HsTypeEnum = "HS" | "SAC";
  * @returns {PageType}
  */
 declare function PageType(): PageType;
-type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt" | "files";
+type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "profile-loyalty-rewards" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt" | "files";

package/sdk/platform/Catalog/CatalogPlatformModel.js

@@ -5453,6 +5453,7 @@ const Joi = require("joi");
  *   | "profile-company"
  *   | "profile-email"
  *   | "profile-phone"
+ *   | "profile-loyalty-rewards"
  *   | "rate-us"
  *   | "refer-earn"
  *   | "settings"
@@ -11316,6 +11317,8 @@ class CatalogPlatformModel {
 
       "profile-phone",
 
+      "profile-loyalty-rewards",
+
       "rate-us",
 
       "refer-earn",

package/sdk/platform/Content/ContentPlatformModel.d.ts

@@ -1637,6 +1637,7 @@ export = ContentPlatformModel;
  *   | "profile-company"
  *   | "profile-email"
  *   | "profile-phone"
+ *   | "profile-loyalty-rewards"
  *   | "rate-us"
  *   | "refer-earn"
  *   | "settings"
@@ -4751,4 +4752,4 @@ type GenerationEntityType = "title" | "description";
  * @returns {PageType}
  */
 declare function PageType(): PageType;
-type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt" | "files";
+type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "profile-loyalty-rewards" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt" | "files";

package/sdk/platform/Content/ContentPlatformModel.js

@@ -1844,6 +1844,7 @@ const Joi = require("joi");
  *   | "profile-company"
  *   | "profile-email"
  *   | "profile-phone"
+ *   | "profile-loyalty-rewards"
  *   | "rate-us"
  *   | "refer-earn"
  *   | "settings"
@@ -4115,6 +4116,8 @@ class ContentPlatformModel {
 
       "profile-phone",
 
+      "profile-loyalty-rewards",
+
       "rate-us",
 
       "refer-earn",

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

@@ -2671,18 +2671,18 @@ export = OrderPlatformModel;
  */
 /**
  * @typedef BundleDetailsSchema
- * @property {boolean} [is_base] - This serves as the base item, with all other
+ * @property {boolean} is_base - This serves as the base item, with all other
  *   items acting as child elements within the bundle to display the hero
  *   product prominently at the top.
- * @property {string[]} [images] - An array of image URLs associated with the bundle.
- * @property {string} [group_id] - Unique group identifier for the bundle
+ * @property {string[]} images - An array of image URLs associated with the bundle.
+ * @property {string} group_id - Unique group identifier for the bundle
  *   generated by seller to club the articles
- * @property {string} [name] - Name of the bundle.
- * @property {string} [item_type] - Type of the bundle item
- * @property {number} [item_id] - Unique identifier of the item.
- * @property {string} [item_code] - Item code for the item.
- * @property {string} [item_name] - Name of the item.
- * @property {string} [seller_identifier] - Identifier for the seller of the bundle.
+ * @property {string} name - Name of the bundle.
+ * @property {string} item_type - Type of the bundle item
+ * @property {number} item_id - Unique identifier of the item.
+ * @property {string} item_code - Item code for the item.
+ * @property {string} item_name - Name of the item.
+ * @property {string} seller_identifier - Identifier for the seller of the bundle.
  * @property {number} [bundle_article_quantity] - In orders with multiple
  *   quantities of the same line item, the line item count remains constant, but
  *   multiple bundles can exist. To distinguish between these bundles, the
@@ -11020,40 +11020,40 @@ type BundleDetailsSchema = {
      * items acting as child elements within the bundle to display the hero
      * product prominently at the top.
      */
-    is_base?: boolean;
+    is_base: boolean;
     /**
      * - An array of image URLs associated with the bundle.
      */
-    images?: string[];
+    images: string[];
     /**
      * - Unique group identifier for the bundle
      * generated by seller to club the articles
      */
-    group_id?: string;
+    group_id: string;
     /**
      * - Name of the bundle.
      */
-    name?: string;
+    name: string;
     /**
      * - Type of the bundle item
      */
-    item_type?: string;
+    item_type: string;
     /**
      * - Unique identifier of the item.
      */
-    item_id?: number;
+    item_id: number;
     /**
      * - Item code for the item.
      */
-    item_code?: string;
+    item_code: string;
     /**
      * - Name of the item.
      */
-    item_name?: string;
+    item_name: string;
     /**
      * - Identifier for the seller of the bundle.
      */
-    seller_identifier?: string;
+    seller_identifier: string;
     /**
      * - In orders with multiple
      * quantities of the same line item, the line item count remains constant, but

package/sdk/platform/Order/OrderPlatformModel.js

@@ -2915,18 +2915,18 @@ const Joi = require("joi");
 
 /**
  * @typedef BundleDetailsSchema
- * @property {boolean} [is_base] - This serves as the base item, with all other
+ * @property {boolean} is_base - This serves as the base item, with all other
  *   items acting as child elements within the bundle to display the hero
  *   product prominently at the top.
- * @property {string[]} [images] - An array of image URLs associated with the bundle.
- * @property {string} [group_id] - Unique group identifier for the bundle
+ * @property {string[]} images - An array of image URLs associated with the bundle.
+ * @property {string} group_id - Unique group identifier for the bundle
  *   generated by seller to club the articles
- * @property {string} [name] - Name of the bundle.
- * @property {string} [item_type] - Type of the bundle item
- * @property {number} [item_id] - Unique identifier of the item.
- * @property {string} [item_code] - Item code for the item.
- * @property {string} [item_name] - Name of the item.
- * @property {string} [seller_identifier] - Identifier for the seller of the bundle.
+ * @property {string} name - Name of the bundle.
+ * @property {string} item_type - Type of the bundle item
+ * @property {number} item_id - Unique identifier of the item.
+ * @property {string} item_code - Item code for the item.
+ * @property {string} item_name - Name of the item.
+ * @property {string} seller_identifier - Identifier for the seller of the bundle.
  * @property {number} [bundle_article_quantity] - In orders with multiple
  *   quantities of the same line item, the line item count remains constant, but
  *   multiple bundles can exist. To distinguish between these bundles, the
@@ -8781,15 +8781,15 @@ class OrderPlatformModel {
   /** @returns {BundleDetailsSchema} */
   static BundleDetailsSchema() {
     return Joi.object({
-      is_base: Joi.boolean(),
-      images: Joi.array().items(Joi.string().allow("")),
-      group_id: Joi.string().allow(""),
-      name: Joi.string().allow(""),
-      item_type: Joi.string().allow(""),
-      item_id: Joi.number(),
-      item_code: Joi.string().allow(""),
-      item_name: Joi.string().allow(""),
-      seller_identifier: Joi.string().allow(""),
+      is_base: Joi.boolean().required(),
+      images: Joi.array().items(Joi.string().allow("")).required(),
+      group_id: Joi.string().allow("").required(),
+      name: Joi.string().allow("").required(),
+      item_type: Joi.string().allow("").required(),
+      item_id: Joi.number().required(),
+      item_code: Joi.string().allow("").required(),
+      item_name: Joi.string().allow("").required(),
+      seller_identifier: Joi.string().allow("").required(),
       bundle_article_quantity: Joi.number(),
       brand_name: Joi.string().allow(""),
       size: Joi.string().allow(""),

package/sdk/platform/Theme/ThemePlatformModel.d.ts

@@ -584,6 +584,7 @@ export = ThemePlatformModel;
  *   | "profile-company"
  *   | "profile-email"
  *   | "profile-phone"
+ *   | "profile-loyalty-rewards"
  *   | "rate-us"
  *   | "refer-earn"
  *   | "settings"
@@ -1667,4 +1668,4 @@ type ActionPage = {
  * @returns {PageType}
  */
 declare function PageType(): PageType;
-type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt" | "files";
+type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-email" | "profile-phone" | "profile-loyalty-rewards" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout" | "request-reattempt" | "files";

package/sdk/platform/Theme/ThemePlatformModel.js

@@ -667,6 +667,7 @@ const Joi = require("joi");
  *   | "profile-company"
  *   | "profile-email"
  *   | "profile-phone"
+ *   | "profile-loyalty-rewards"
  *   | "rate-us"
  *   | "refer-earn"
  *   | "settings"
@@ -1561,6 +1562,8 @@ class ThemePlatformModel {
 
       "profile-phone",
 
+      "profile-loyalty-rewards",
+
       "rate-us",
 
       "refer-earn",