@gofynd/fdk-client-javascript 1.4.16-beta.1 → 1.4.16-beta.3

package/sdk/application/Webhook/WebhookApplicationClient.js

@@ -6,6 +6,7 @@ const {
 const ApplicationAPIClient = require("../ApplicationAPIClient");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
+const { validateRequiredParams } = require("../../common/Validator");
 
 class Webhook {
   constructor(_conf) {
@@ -42,14 +43,6 @@ class Webhook {
     { body, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const query_params = {};
 
     const xHeaders = {};

package/sdk/common/Utility.d.ts

@@ -1,4 +1,4 @@
-export function convertActionToUrl(action: any): any;
+export function convertActionToUrl(action: any, locale: any): any;
 export function convertUrlToAction(url: any): {
     type: string;
     page: {

package/sdk/common/Utility.js

@@ -65,7 +65,7 @@ function convertUrlToAction(url) {
   }
 }
 
-function convertActionToUrl(action) {
+function convertActionToUrl(action, locale) {
   if (action && action.page && action.page.type) {
     switch (action.type) {
       case utils.NAV_TYPE.PAGE: {
@@ -83,16 +83,16 @@ function convertActionToUrl(action) {
             item.link +=
               "/?" + utils.transformRequestOptions(action.page.query);
           }
-          return item.link;
+          return locale ? `/${locale}${item.link}` : item.link;
         }
-        return "";
+        return locale ? `/${locale}` : "";
       }
       case utils.NAV_TYPE.POPUP: {
         break;
       }
     }
   } else {
-    return "";
+    return locale ? `/${locale}` : "";
   }
 }
 

package/sdk/common/Validator.d.ts

@@ -0,0 +1 @@
+export function validateRequiredParams(params: any, requiredParams: any): any[];

package/sdk/common/Validator.js

@@ -0,0 +1,20 @@
+function validateRequiredParams(params, requiredParams) {
+  const errors = [];
+  requiredParams.forEach((key) => {
+    const value = params[key];
+
+    // Reject missing or empty values (except for boolean false)
+    if (
+      value === undefined ||
+      value === null ||
+      (typeof value !== "boolean" && value === "")
+    ) {
+      errors.push(`Missing or empty required parameter: ${key}`);
+    }
+  });
+  return errors;
+}
+
+module.exports = {
+  validateRequiredParams,
+};

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

@@ -181,6 +181,8 @@ export = CartPlatformModel;
  * @property {Validity} [validity]
  * @property {RuleDefinition} [rule_definition]
  * @property {string} [_id] - Unique identifier of coupon
+ * @property {boolean} [is_archived] - Indicates if the coupon is in archived
+ *   state or not.
  */
 /**
  * @typedef Page
@@ -319,6 +321,7 @@ export = CartPlatformModel;
  * @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 {string[]} [item_exclude_product_tags]
  */
 /**
  * @typedef DiscountOffer
@@ -461,6 +464,8 @@ export = CartPlatformModel;
  * @property {PromotionDateMeta} [date_meta]
  * @property {string} [_id] - Unique identifier of promotion
  * @property {string[]} [tags] - List of tags on which promotion is applicable
+ * @property {boolean} [is_archived] - Indicates if the promotion is in archived
+ *   state or not.
  */
 /**
  * @typedef PromotionsResult
@@ -496,6 +501,7 @@ export = CartPlatformModel;
  * @property {Object} [_custom_json] - Set extra properties in promotion
  * @property {PromotionDateMeta} [date_meta]
  * @property {string[]} [tags] - List of tags applicable for promotion
+ * @property {string} [_id] - Unique Identifier for promotion.
  */
 /**
  * @typedef PromotionAddResult
@@ -528,6 +534,8 @@ export = CartPlatformModel;
  * @property {Object} [_custom_json] - Set extra properties in promotion
  * @property {PromotionDateMeta} [date_meta]
  * @property {string[]} [tags] - List of tags applicable for promotion
+ * @property {boolean} [is_archived] - Indicates if the promotion is in archived
+ *   state or not.
  */
 /**
  * @typedef PromotionUpdate
@@ -594,6 +602,8 @@ export = CartPlatformModel;
  * @property {Object} [_custom_json] - Set extra properties in promotion
  * @property {PromotionDateMeta} [date_meta]
  * @property {string[]} [tags] - List of tags applicable for promotion
+ * @property {boolean} [is_archived] - Indicates if the promotion is in archived
+ *   state or not.
  */
 /**
  * @typedef PromotionPartialUpdate
@@ -2705,6 +2715,11 @@ type CouponAdd = {
      * - Unique identifier of coupon
      */
     _id?: string;
+    /**
+     * - Indicates if the coupon is in archived
+     * state or not.
+     */
+    is_archived?: boolean;
 };
 /** @returns {Page} */
 declare function Page(): Page;
@@ -3029,6 +3044,7 @@ type ItemCriteria = {
      * - List of all item sku on which promotion is applicable
      */
     item_sku?: string[];
+    item_exclude_product_tags?: string[];
 };
 /** @returns {DiscountOffer} */
 declare function DiscountOffer(): DiscountOffer;
@@ -3378,6 +3394,11 @@ type PromotionListItem = {
      * - List of tags on which promotion is applicable
      */
     tags?: string[];
+    /**
+     * - Indicates if the promotion is in archived
+     * state or not.
+     */
+    is_archived?: boolean;
 };
 /** @returns {PromotionsResult} */
 declare function PromotionsResult(): PromotionsResult;
@@ -3460,6 +3481,10 @@ type PromotionAdd = {
      * - List of tags applicable for promotion
      */
     tags?: string[];
+    /**
+     * - Unique Identifier for promotion.
+     */
+    _id?: string;
 };
 /** @returns {PromotionAddResult} */
 declare function PromotionAddResult(): PromotionAddResult;
@@ -3538,6 +3563,11 @@ type PromotionAddResult = {
      * - List of tags applicable for promotion
      */
     tags?: string[];
+    /**
+     * - Indicates if the promotion is in archived
+     * state or not.
+     */
+    is_archived?: boolean;
 };
 /** @returns {PromotionUpdate} */
 declare function PromotionUpdate(): PromotionUpdate;
@@ -3699,6 +3729,11 @@ type PromotionUpdateResult = {
      * - List of tags applicable for promotion
      */
     tags?: string[];
+    /**
+     * - Indicates if the promotion is in archived
+     * state or not.
+     */
+    is_archived?: boolean;
 };
 /** @returns {PromotionPartialUpdate} */
 declare function PromotionPartialUpdate(): PromotionPartialUpdate;

package/sdk/platform/Cart/CartPlatformModel.js

@@ -203,6 +203,8 @@ const Joi = require("joi");
  * @property {Validity} [validity]
  * @property {RuleDefinition} [rule_definition]
  * @property {string} [_id] - Unique identifier of coupon
+ * @property {boolean} [is_archived] - Indicates if the coupon is in archived
+ *   state or not.
  */
 
 /**
@@ -353,6 +355,7 @@ const Joi = require("joi");
  * @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 {string[]} [item_exclude_product_tags]
  */
 
 /**
@@ -510,6 +513,8 @@ const Joi = require("joi");
  * @property {PromotionDateMeta} [date_meta]
  * @property {string} [_id] - Unique identifier of promotion
  * @property {string[]} [tags] - List of tags on which promotion is applicable
+ * @property {boolean} [is_archived] - Indicates if the promotion is in archived
+ *   state or not.
  */
 
 /**
@@ -547,6 +552,7 @@ const Joi = require("joi");
  * @property {Object} [_custom_json] - Set extra properties in promotion
  * @property {PromotionDateMeta} [date_meta]
  * @property {string[]} [tags] - List of tags applicable for promotion
+ * @property {string} [_id] - Unique Identifier for promotion.
  */
 
 /**
@@ -580,6 +586,8 @@ const Joi = require("joi");
  * @property {Object} [_custom_json] - Set extra properties in promotion
  * @property {PromotionDateMeta} [date_meta]
  * @property {string[]} [tags] - List of tags applicable for promotion
+ * @property {boolean} [is_archived] - Indicates if the promotion is in archived
+ *   state or not.
  */
 
 /**
@@ -648,6 +656,8 @@ const Joi = require("joi");
  * @property {Object} [_custom_json] - Set extra properties in promotion
  * @property {PromotionDateMeta} [date_meta]
  * @property {string[]} [tags] - List of tags applicable for promotion
+ * @property {boolean} [is_archived] - Indicates if the promotion is in archived
+ *   state or not.
  */
 
 /**
@@ -2696,6 +2706,7 @@ class CartPlatformModel {
       validity: CartPlatformModel.Validity(),
       rule_definition: CartPlatformModel.RuleDefinition(),
       _id: Joi.string().allow(""),
+      is_archived: Joi.boolean(),
     });
   }
 
@@ -2846,6 +2857,7 @@ class CartPlatformModel {
       item_tags: Joi.array().items(Joi.string().allow("")),
       item_exclude_l2_category: Joi.array().items(Joi.number()),
       item_sku: Joi.array().items(Joi.string().allow("")),
+      item_exclude_product_tags: Joi.array().items(Joi.string().allow("")),
     });
   }
 
@@ -3021,6 +3033,7 @@ class CartPlatformModel {
       date_meta: CartPlatformModel.PromotionDateMeta(),
       _id: Joi.string().allow(""),
       tags: Joi.array().items(Joi.string().allow("")),
+      is_archived: Joi.boolean(),
     });
   }
 
@@ -3058,6 +3071,7 @@ class CartPlatformModel {
       _custom_json: Joi.object().pattern(/\S/, Joi.any()),
       date_meta: CartPlatformModel.PromotionDateMeta(),
       tags: Joi.array().items(Joi.string().allow("")),
+      _id: Joi.string().allow(""),
     });
   }
 
@@ -3088,6 +3102,7 @@ class CartPlatformModel {
       _custom_json: Joi.object().pattern(/\S/, Joi.any()),
       date_meta: CartPlatformModel.PromotionDateMeta(),
       tags: Joi.array().items(Joi.string().allow("")),
+      is_archived: Joi.boolean(),
     });
   }
 
@@ -3149,6 +3164,7 @@ class CartPlatformModel {
       _custom_json: Joi.object().pattern(/\S/, Joi.any()),
       date_meta: CartPlatformModel.PromotionDateMeta(),
       tags: Joi.array().items(Joi.string().allow("")),
+      is_archived: Joi.boolean(),
     });
   }
 

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

@@ -102,6 +102,7 @@ export = CatalogPlatformModel;
  * @property {string} [name] - Name of the application.
  * @property {number} priority - Defines the priority level for this
  *   configuration, with 1 being the highest.
+ * @property {ApplicationItemSEO} [seo]
  */
 /**
  * @typedef ApplicationBrandJson
@@ -1559,6 +1560,7 @@ export = CatalogPlatformModel;
  * @property {string} [slug] - A URL-friendly identifier for the configuration group.
  * @property {string[]} [template_slugs] - A list of template slugs associated
  *   with this configuration.
+ * @property {ApplicationItemSEO} [seo]
  */
 /**
  * @typedef AttributeConfig
@@ -4508,6 +4510,7 @@ type AppConfigurationsSort = {
      * configuration, with 1 being the highest.
      */
     priority: number;
+    seo?: ApplicationItemSEO;
 };
 /** @returns {ApplicationBrandJson} */
 declare function ApplicationBrandJson(): ApplicationBrandJson;
@@ -7501,6 +7504,7 @@ type ConfigItem = {
      * with this configuration.
      */
     template_slugs?: string[];
+    seo?: ApplicationItemSEO;
 };
 /** @returns {AttributeConfig} */
 declare function AttributeConfig(): AttributeConfig;

package/sdk/platform/Catalog/CatalogPlatformModel.js

@@ -111,6 +111,7 @@ const Joi = require("joi");
  * @property {string} [name] - Name of the application.
  * @property {number} priority - Defines the priority level for this
  *   configuration, with 1 being the highest.
+ * @property {ApplicationItemSEO} [seo]
  */
 
 /**
@@ -1718,6 +1719,7 @@ const Joi = require("joi");
  * @property {string} [slug] - A URL-friendly identifier for the configuration group.
  * @property {string[]} [template_slugs] - A list of template slugs associated
  *   with this configuration.
+ * @property {ApplicationItemSEO} [seo]
  */
 
 /**
@@ -4826,6 +4828,7 @@ class CatalogPlatformModel {
       logo: Joi.string().allow(""),
       name: Joi.string().allow(""),
       priority: Joi.number().required(),
+      seo: CatalogPlatformModel.ApplicationItemSEO(),
     });
   }
 
@@ -6572,6 +6575,7 @@ class CatalogPlatformModel {
       priority: Joi.number(),
       slug: Joi.string().allow(""),
       template_slugs: Joi.array().items(Joi.string().allow("")),
+      seo: CatalogPlatformModel.ApplicationItemSEO(),
     });
   }
 

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

@@ -177,6 +177,17 @@ declare class Content {
      * @description: Use this API to Create SEO Markup Schema - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createSEOMarkupSchema/).
      */
     createSEOMarkupSchema({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateSEOMarkupSchemaParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SEOSchemaMarkupTemplate>;
+    /**
+     * @param {ContentPlatformApplicationValidator.CreateSitemapParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<ContentPlatformModel.SitemapConfig>} - Success response
+     * @name createSitemap
+     * @summary: Create a new sitemap configuration
+     * @description: Create a new sitemap configuration for a specific company and application. The name must be unique within the scope of the application. The sitemap XML data must be valid XML following the sitemap protocol specification. Once created, the configuration can be activated or deactivated using the is_active flag.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createSitemap/).
+     */
+    createSitemap({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateSitemapParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SitemapConfig>;
     /**
      * @param {ContentPlatformApplicationValidator.CreateSlideshowParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -337,6 +348,17 @@ declare class Content {
      * @description: Use this API to Delete SEO Markup Schema - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteSEOMarkupSchema/).
      */
     deleteSEOMarkupSchema({ id, requestHeaders }?: ContentPlatformApplicationValidator.DeleteSEOMarkupSchemaParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SEOSchemaMarkupTemplate>;
+    /**
+     * @param {ContentPlatformApplicationValidator.DeleteSitemapParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<ContentPlatformModel.SitemapConfig>} - Success response
+     * @name deleteSitemap
+     * @summary: Delete a specific sitemap configuration
+     * @description: Permanently delete a sitemap configuration identified by its name. This action cannot be undone. All associated data including the sitemap XML data will be removed.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteSitemap/).
+     */
+    deleteSitemap({ name, requestHeaders }?: ContentPlatformApplicationValidator.DeleteSitemapParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SitemapConfig>;
     /**
      * @param {ContentPlatformApplicationValidator.DeleteSlideshowParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -637,6 +659,18 @@ declare class Content {
      * @description: Use this API to List default SEO Markup Schemas - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getDefaultSEOMarkupSchema/).
      */
     getDefaultSEOMarkupSchema({ pageType, requestHeaders }?: ContentPlatformApplicationValidator.GetDefaultSEOMarkupSchemaParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DefaultSchemaComponent>;
+    /**
+     * @param {ContentPlatformApplicationValidator.GetDefaultSitemapConfigParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<ContentPlatformModel.DefaultSitemapConfig>} - Success response
+     * @name getDefaultSitemapConfig
+     * @summary: Get default sitemap configuration
+     * @description: Retrieves the current default sitemap configuration settings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getDefaultSitemapConfig/).
+     */
+    getDefaultSitemapConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.DefaultSitemapConfig>;
     /**
      * @param {ContentPlatformApplicationValidator.GetFaqByIdOrSlugParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -838,6 +872,29 @@ declare class Content {
      * @description: Use this API to List default SEO Markup Schemas - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSEOMarkupSchemas/).
      */
     getSEOMarkupSchemas({ title, active, pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetSEOMarkupSchemasParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SeoSchemaComponent>;
+    /**
+     * @param {ContentPlatformApplicationValidator.GetSitemapParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<ContentPlatformModel.SitemapConfig>} - Success response
+     * @name getSitemap
+     * @summary: Get a specific sitemap configuration
+     * @description: Retrieve a specific sitemap configuration by its name. Returns the complete configuration including the sitemap XML data, activation status, and timestamps.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSitemap/).
+     */
+    getSitemap({ name, requestHeaders }?: ContentPlatformApplicationValidator.GetSitemapParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SitemapConfig>;
+    /**
+     * @param {ContentPlatformApplicationValidator.GetSitemapsParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<ContentPlatformModel.SitemapConfigurationList>} -
+     *   Success response
+     * @name getSitemaps
+     * @summary: List sitemap configurations
+     * @description: Retrieve a list of sitemap configurations for a specific company and application. Each configuration contains the sitemap XML data and its activation status.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSitemaps/).
+     */
+    getSitemaps({ pageNo, pageSize, isActive, name, requestHeaders }?: ContentPlatformApplicationValidator.GetSitemapsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SitemapConfigurationList>;
     /**
      * @param {ContentPlatformApplicationValidator.GetSlideshowBySlugParam} arg
      *   - Arg object
@@ -1023,6 +1080,18 @@ declare class Content {
      * @description: Modify the content and settings of a specific blog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateBlog/).
      */
     updateBlog({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateBlogParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogSchema>;
+    /**
+     * @param {ContentPlatformApplicationValidator.UpdateDefaultSitemapConfigParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<ContentPlatformModel.DefaultSitemapConfig>} - Success response
+     * @name updateDefaultSitemapConfig
+     * @summary: Update default sitemap configuration
+     * @description: Updates the default sitemap configuration settings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateDefaultSitemapConfig/).
+     */
+    updateDefaultSitemapConfig({ body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateDefaultSitemapConfigParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DefaultSitemapConfig>;
     /**
      * @param {ContentPlatformApplicationValidator.UpdateFaqParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -1137,6 +1206,17 @@ declare class Content {
      * @description: Modify configuration settings for SEO. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateSEOConfiguration/).
      */
     updateSEOConfiguration({ body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateSEOConfigurationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SeoSchema>;
+    /**
+     * @param {ContentPlatformApplicationValidator.UpdateSitemapParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<ContentPlatformModel.SitemapConfig>} - Success response
+     * @name updateSitemap
+     * @summary: Update a specific sitemap configuration
+     * @description: Update an existing sitemap configuration identified by its name. You can update the activation status and/or the sitemap XML data. The name cannot be modified once the configuration is created. The updated sitemap XML data must be valid XML following the sitemap protocol specification.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateSitemap/).
+     */
+    updateSitemap({ name, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateSitemapParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SitemapConfig>;
     /**
      * @param {ContentPlatformApplicationValidator.UpdateSlideshowParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`