@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

package/sdk/application/User/UserApplicationValidator.js

@@ -231,4 +231,5 @@ class UserValidator {
     }).required();
   }
 }
+
 module.exports = UserValidator;

package/sdk/common/AxiosHelper.js

@@ -38,7 +38,7 @@ function requestInterceptorFn() {
     }
     const { host, pathname, search } = new URL(url);
     const { data, headers, method, params } = config;
-    headers["x-fp-sdk-version"] = "1.0.0";
+    headers["x-fp-sdk-version"] = "1.0.1";
     let querySearchObj = querystring.parse(search);
     querySearchObj = { ...querySearchObj, ...params };
     let queryParam = "";

package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts

@@ -5,52 +5,58 @@ declare class Analytics {
     applicationId: any;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<StatsGroups>} - Success response
      * @summary: Get statistics groups
      * @description: Get statistics groups
      */
-    getStatiscticsGroups({}?: any): Promise<any>;
+    getStatiscticsGroups({}?: any): Promise<StatsGroups>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.groupName - Group name
+     * @returns {Promise<StatsGroupComponents>} - Success response
      * @summary: Get statistics group components
      * @description: Get statistics group components
      */
     getStatiscticsGroupComponents({ groupName }?: {
         groupName: string;
-    }): Promise<any>;
+    }): Promise<StatsGroupComponents>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.componentName - Component name
+     * @returns {Promise<string>} - Success response
      * @summary: Get component statistics csv
      * @description: Get component statistics csv
      */
     getComponentStatsCSV({ componentName }?: {
         componentName: string;
-    }): Promise<any>;
+    }): Promise<string>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.componentName - Component name
+     * @returns {Promise<string>} - Success response
      * @summary: Get component statistics pdf
      * @description: Get component statistics pdf
      */
     getComponentStatsPDF({ componentName }?: {
         componentName: string;
-    }): Promise<any>;
+    }): Promise<string>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.componentName - Component name
+     * @returns {Promise<StatsRes>} - Success response
      * @summary: Get component statistics
      * @description: Get component statistics
      */
     getComponentStats({ componentName }?: {
         componentName: string;
-    }): Promise<any>;
+    }): Promise<StatsRes>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.fromDate - From date
      * @param {string} arg.toDate - To date
      * @param {number} [arg.pageNo] - Current page number
      * @param {number} [arg.pageSize] - Current page size
+     * @returns {Promise<AbandonCartsList>} - Success response
      * @summary: Get abandon carts list
      * @description: Get abandon carts list
      */
@@ -59,7 +65,7 @@ declare class Analytics {
         toDate: string;
         pageNo?: number;
         pageSize?: number;
-    }): Promise<any>;
+    }): Promise<AbandonCartsList>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Company Id
@@ -81,21 +87,23 @@ declare class Analytics {
      * @param {Object} arg - Arg object.
      * @param {string} arg.fromDate - From date
      * @param {string} arg.toDate - To date
+     * @returns {Promise<string>} - Success response
      * @summary: Get abandon carts csv
      * @description: Get abandon carts csv
      */
     getAbandonCartsCSV({ fromDate, toDate }?: {
         fromDate: string;
         toDate: string;
-    }): Promise<any>;
+    }): Promise<string>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.cartId - Cart Id
+     * @returns {Promise<AbandonCartDetail>} - Success response
      * @summary: Get abandon carts details
      * @description: Get abandon cart details
      */
     getAbandonCartDetail({ cartId }?: {
         cartId: string;
-    }): Promise<any>;
+    }): Promise<AbandonCartDetail>;
 }
 import Paginator = require("../../common/Paginator");

package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js

@@ -2,6 +2,8 @@ const Paginator = require("../../common/Paginator");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const AnalyticsValidator = require("./AnalyticsPlatformApplicationValidator");
+const AnalyticsModel = require("./AnalyticsPlatformModel");
+const { Logger } = require("./../../common/Logger");
 
 class Analytics {
   constructor(config, applicationId) {
@@ -11,10 +13,11 @@ class Analytics {
 
   /**
    * @param {Object} arg - Arg object.
+   * @returns {Promise<StatsGroups>} - Success response
    * @summary: Get statistics groups
    * @description: Get statistics groups
    */
-  getStatiscticsGroups({} = {}) {
+  async getStatiscticsGroups({} = {}) {
     const { error } = AnalyticsValidator.getStatiscticsGroups().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -23,24 +26,55 @@ class Analytics {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = AnalyticsValidator.getStatiscticsGroups().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getStatiscticsGroups",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/analytics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/stats/group`,
       query_params,
       undefined
     );
+
+    const { error: res_error } = AnalyticsModel.StatsGroups().validate(
+      response,
+      { abortEarly: false, allowUnknown: false }
+    );
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getStatiscticsGroups",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.groupName - Group name
+   * @returns {Promise<StatsGroupComponents>} - Success response
    * @summary: Get statistics group components
    * @description: Get statistics group components
    */
-  getStatiscticsGroupComponents({ groupName } = {}) {
+  async getStatiscticsGroupComponents({ groupName } = {}) {
     const {
       error,
     } = AnalyticsValidator.getStatiscticsGroupComponents().validate(
@@ -53,24 +87,61 @@ class Analytics {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = AnalyticsValidator.getStatiscticsGroupComponents().validate(
+      {
+        groupName,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message:
+          "Parameter Validation warrnings for getStatiscticsGroupComponents",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/analytics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/stats/group/${groupName}`,
       query_params,
       undefined
     );
+
+    const {
+      error: res_error,
+    } = AnalyticsModel.StatsGroupComponents().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message:
+          "Response Validation Warnnings for getStatiscticsGroupComponents",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.componentName - Component name
+   * @returns {Promise<string>} - Success response
    * @summary: Get component statistics csv
    * @description: Get component statistics csv
    */
-  getComponentStatsCSV({ componentName } = {}) {
+  async getComponentStatsCSV({ componentName } = {}) {
     const { error } = AnalyticsValidator.getComponentStatsCSV().validate(
       {
         componentName,
@@ -81,24 +152,56 @@ class Analytics {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = AnalyticsValidator.getComponentStatsCSV().validate(
+      {
+        componentName,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getComponentStatsCSV",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/analytics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/stats/component/{component_name}.csv`,
       query_params,
       undefined
     );
+
+    const { error: res_error } = Joi.string()
+      .allow("")
+      .validate(response, { abortEarly: false, allowUnknown: false });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getComponentStatsCSV",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.componentName - Component name
+   * @returns {Promise<string>} - Success response
    * @summary: Get component statistics pdf
    * @description: Get component statistics pdf
    */
-  getComponentStatsPDF({ componentName } = {}) {
+  async getComponentStatsPDF({ componentName } = {}) {
     const { error } = AnalyticsValidator.getComponentStatsPDF().validate(
       {
         componentName,
@@ -109,24 +212,56 @@ class Analytics {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = AnalyticsValidator.getComponentStatsPDF().validate(
+      {
+        componentName,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getComponentStatsPDF",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/analytics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/stats/component/{component_name}.pdf`,
       query_params,
       undefined
     );
+
+    const { error: res_error } = Joi.string()
+      .allow("")
+      .validate(response, { abortEarly: false, allowUnknown: false });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getComponentStatsPDF",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.componentName - Component name
+   * @returns {Promise<StatsRes>} - Success response
    * @summary: Get component statistics
    * @description: Get component statistics
    */
-  getComponentStats({ componentName } = {}) {
+  async getComponentStats({ componentName } = {}) {
     const { error } = AnalyticsValidator.getComponentStats().validate(
       {
         componentName,
@@ -137,15 +272,45 @@ class Analytics {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = AnalyticsValidator.getComponentStats().validate(
+      {
+        componentName,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getComponentStats",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/analytics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/stats/component/${componentName}`,
       query_params,
       undefined
     );
+
+    const { error: res_error } = AnalyticsModel.StatsRes().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getComponentStats",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -154,10 +319,11 @@ class Analytics {
    * @param {string} arg.toDate - To date
    * @param {number} [arg.pageNo] - Current page number
    * @param {number} [arg.pageSize] - Current page size
+   * @returns {Promise<AbandonCartsList>} - Success response
    * @summary: Get abandon carts list
    * @description: Get abandon carts list
    */
-  getAbandonCartList({ fromDate, toDate, pageNo, pageSize } = {}) {
+  async getAbandonCartList({ fromDate, toDate, pageNo, pageSize } = {}) {
     const { error } = AnalyticsValidator.getAbandonCartList().validate(
       {
         fromDate,
@@ -171,17 +337,54 @@ class Analytics {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = AnalyticsValidator.getAbandonCartList().validate(
+      {
+        fromDate,
+        toDate,
+        pageNo,
+        pageSize,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getAbandonCartList",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["page_no"] = pageNo;
     query_params["page_size"] = pageSize;
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/analytics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/cart/from/${fromDate}/to/${toDate}/abandon-cart/`,
       query_params,
       undefined
     );
+
+    const {
+      error: res_error,
+    } = AnalyticsModel.AbandonCartsList().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getAbandonCartList",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -228,10 +431,11 @@ class Analytics {
    * @param {Object} arg - Arg object.
    * @param {string} arg.fromDate - From date
    * @param {string} arg.toDate - To date
+   * @returns {Promise<string>} - Success response
    * @summary: Get abandon carts csv
    * @description: Get abandon carts csv
    */
-  getAbandonCartsCSV({ fromDate, toDate } = {}) {
+  async getAbandonCartsCSV({ fromDate, toDate } = {}) {
     const { error } = AnalyticsValidator.getAbandonCartsCSV().validate(
       {
         fromDate,
@@ -243,24 +447,57 @@ class Analytics {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = AnalyticsValidator.getAbandonCartsCSV().validate(
+      {
+        fromDate,
+        toDate,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getAbandonCartsCSV",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/analytics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/cart/${fromDate}/to/${toDate}/abandon-cart.csv`,
       query_params,
       undefined
     );
+
+    const { error: res_error } = Joi.string()
+      .allow("")
+      .validate(response, { abortEarly: false, allowUnknown: false });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getAbandonCartsCSV",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.cartId - Cart Id
+   * @returns {Promise<AbandonCartDetail>} - Success response
    * @summary: Get abandon carts details
    * @description: Get abandon cart details
    */
-  getAbandonCartDetail({ cartId } = {}) {
+  async getAbandonCartDetail({ cartId } = {}) {
     const { error } = AnalyticsValidator.getAbandonCartDetail().validate(
       {
         cartId,
@@ -271,15 +508,49 @@ class Analytics {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = AnalyticsValidator.getAbandonCartDetail().validate(
+      {
+        cartId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getAbandonCartDetail",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/analytics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/cart/abandon-cart/${cartId}`,
       query_params,
       undefined
     );
+
+    const {
+      error: res_error,
+    } = AnalyticsModel.AbandonCartDetail().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getAbandonCartDetail",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 }
 module.exports = Analytics;

package/sdk/platform/Analytics/AnalyticsPlatformClient.d.ts

@@ -6,30 +6,33 @@ declare class Analytics {
      * @param {Object} arg - Arg object.
      * @param {string} arg.exportType - Export type / format
      * @param {ExportJobReq} arg.body
+     * @returns {Promise<ExportJobRes>} - Success response
      * @summary: Create data export job in required format
      * @description: Create data export job in required format
      */
     createExportJob({ exportType, body }?: {
         exportType: string;
         body: ExportJobReq;
-    }): Promise<any>;
+    }): Promise<ExportJobRes>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.exportType - Export type / format
      * @param {string} arg.jobId - Export job id
+     * @returns {Promise<ExportJobStatusRes>} - Success response
      * @summary: Get data export job status
      * @description: Get data export job status
      */
     getExportJobStatus({ exportType, jobId }?: {
         exportType: string;
         jobId: string;
-    }): Promise<any>;
+    }): Promise<ExportJobStatusRes>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.logType - Log type
      * @param {number} [arg.pageNo] - Current page number
      * @param {number} [arg.pageSize] - Current page size
      * @param {GetLogsListReq} arg.body
+     * @returns {Promise<GetLogsListRes>} - Success response
      * @summary: Get logs list
      * @description: Get logs list
      */
@@ -38,7 +41,7 @@ declare class Analytics {
         pageNo?: number;
         pageSize?: number;
         body: GetLogsListReq;
-    }): Promise<any>;
+    }): Promise<GetLogsListRes>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.logType - Log type
@@ -58,6 +61,7 @@ declare class Analytics {
      * @param {number} [arg.pageSize] - Current page size
      * @param {string} arg.logType - Log type
      * @param {SearchLogReq} arg.body
+     * @returns {Promise<SearchLogRes>} - Success response
      * @summary: Search logs
      * @description: Search logs
      */
@@ -66,7 +70,7 @@ declare class Analytics {
         pageSize?: number;
         logType: string;
         body: SearchLogReq;
-    }): Promise<any>;
+    }): Promise<SearchLogRes>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] - Current page size