@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

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,12 +13,16 @@ class Analytics {
 
   /**
    * @param {Object} arg - Arg object.
-   * @summary: Get statistics groups
-   * @description: Get statistics groups
+   * @param {string} arg.cartId - Cart Id
+   * @returns {Promise<AbandonCartDetail>} - Success response
+   * @summary: Get abandon carts details
+   * @description: Get abandon cart details
    */
-  getStatiscticsGroups({} = {}) {
-    const { error } = AnalyticsValidator.getStatiscticsGroups().validate(
-      {},
+  async getAbandonCartDetail({ cartId } = {}) {
+    const { error } = AnalyticsValidator.getAbandonCartDetail().validate(
+      {
+        cartId,
+      },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -26,38 +32,65 @@ class Analytics {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = AnalyticsValidator.getStatiscticsGroups().validate(
-      {},
+    } = AnalyticsValidator.getAbandonCartDetail().validate(
+      {
+        cartId,
+      },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getStatiscticsGroups");
-      console.log(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}/stats/group`,
+      `/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;
   }
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.groupName - Group name
-   * @summary: Get statistics group components
-   * @description: Get statistics group components
+   * @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
    */
-  getStatiscticsGroupComponents({ groupName } = {}) {
-    const {
-      error,
-    } = AnalyticsValidator.getStatiscticsGroupComponents().validate(
+  async getAbandonCartList({ fromDate, toDate, pageNo, pageSize } = {}) {
+    const { error } = AnalyticsValidator.getAbandonCartList().validate(
       {
-        groupName,
+        fromDate,
+        toDate,
+        pageNo,
+        pageSize,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -68,40 +101,106 @@ class Analytics {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = AnalyticsValidator.getStatiscticsGroupComponents().validate(
+    } = AnalyticsValidator.getAbandonCartList().validate(
       {
-        groupName,
+        fromDate,
+        toDate,
+        pageNo,
+        pageSize,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log(
-        "Parameter Validation warrnings for getStatiscticsGroupComponents"
-      );
-      console.log(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}/stats/group/${groupName}`,
+      `/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;
   }
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.componentName - Component name
-   * @summary: Get component statistics csv
-   * @description: Get component statistics csv
+   * @param {string} arg.companyId - Company Id
+   * @param {string} arg.applicationId - Application Id
+   * @param {string} arg.fromDate - From date
+   * @param {string} arg.toDate - To date
+   * @param {number} [arg.pageSize] - Current page size
+   * @summary: Get abandon carts list
+   * @description: Get abandon carts list
    */
-  getComponentStatsCSV({ componentName } = {}) {
-    const { error } = AnalyticsValidator.getComponentStatsCSV().validate(
+  getAbandonCartListPaginator({
+    companyId,
+    applicationId,
+    fromDate,
+    toDate,
+    pageSize,
+  } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.getAbandonCartList({
+        companyId: companyId,
+        applicationId: applicationId,
+        fromDate: fromDate,
+        toDate: toDate,
+        pageNo: pageNo,
+        pageSize: pageSize,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback.bind(this));
+    return paginator;
+  }
+
+  /**
+   * @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
+   */
+  async getAbandonCartsCSV({ fromDate, toDate } = {}) {
+    const { error } = AnalyticsValidator.getAbandonCartsCSV().validate(
       {
-        componentName,
+        fromDate,
+        toDate,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -112,36 +211,55 @@ class Analytics {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = AnalyticsValidator.getComponentStatsCSV().validate(
+    } = AnalyticsValidator.getAbandonCartsCSV().validate(
       {
-        componentName,
+        fromDate,
+        toDate,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getComponentStatsCSV");
-      console.log(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}/stats/component/{component_name}.csv`,
+      `/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.componentName - Component name
-   * @summary: Get component statistics pdf
-   * @description: Get component statistics pdf
+   * @returns {Promise<StatsRes>} - Success response
+   * @summary: Get component statistics
+   * @description: Get component statistics
    */
-  getComponentStatsPDF({ componentName } = {}) {
-    const { error } = AnalyticsValidator.getComponentStatsPDF().validate(
+  async getComponentStats({ componentName } = {}) {
+    const { error } = AnalyticsValidator.getComponentStats().validate(
       {
         componentName,
       },
@@ -152,38 +270,55 @@ class Analytics {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = AnalyticsValidator.getComponentStatsPDF().validate(
+    const { error: warrning } = AnalyticsValidator.getComponentStats().validate(
       {
         componentName,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getComponentStatsPDF");
-      console.log(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/{component_name}.pdf`,
+      `/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;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.componentName - Component name
-   * @summary: Get component statistics
-   * @description: Get component statistics
+   * @returns {Promise<string>} - Success response
+   * @summary: Get component statistics csv
+   * @description: Get component statistics csv
    */
-  getComponentStats({ componentName } = {}) {
-    const { error } = AnalyticsValidator.getComponentStats().validate(
+  async getComponentStatsCSV({ componentName } = {}) {
+    const { error } = AnalyticsValidator.getComponentStatsCSV().validate(
       {
         componentName,
       },
@@ -194,44 +329,58 @@ class Analytics {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = AnalyticsValidator.getComponentStats().validate(
+    const {
+      error: warrning,
+    } = AnalyticsValidator.getComponentStatsCSV().validate(
       {
         componentName,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getComponentStats");
-      console.log(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/${componentName}`,
+      `/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.fromDate - From date
-   * @param {string} arg.toDate - To date
-   * @param {number} [arg.pageNo] - Current page number
-   * @param {number} [arg.pageSize] - Current page size
-   * @summary: Get abandon carts list
-   * @description: Get abandon carts list
+   * @param {string} arg.componentName - Component name
+   * @returns {Promise<string>} - Success response
+   * @summary: Get component statistics pdf
+   * @description: Get component statistics pdf
    */
-  getAbandonCartList({ fromDate, toDate, pageNo, pageSize } = {}) {
-    const { error } = AnalyticsValidator.getAbandonCartList().validate(
+  async getComponentStatsPDF({ componentName } = {}) {
+    const { error } = AnalyticsValidator.getComponentStatsPDF().validate(
       {
-        fromDate,
-        toDate,
-        pageNo,
-        pageSize,
+        componentName,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -242,85 +391,58 @@ class Analytics {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = AnalyticsValidator.getAbandonCartList().validate(
+    } = AnalyticsValidator.getComponentStatsPDF().validate(
       {
-        fromDate,
-        toDate,
-        pageNo,
-        pageSize,
+        componentName,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getAbandonCartList");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getComponentStatsPDF",
+      });
+      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/`,
+      `/service/platform/analytics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/stats/component/{component_name}.pdf`,
       query_params,
       undefined
     );
-  }
 
-  /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.companyId - Company Id
-   * @param {string} arg.applicationId - Application Id
-   * @param {string} arg.fromDate - From date
-   * @param {string} arg.toDate - To date
-   * @param {number} [arg.pageSize] - Current page size
-   * @summary: Get abandon carts list
-   * @description: Get abandon carts list
-   */
-  getAbandonCartListPaginator({
-    companyId,
-    applicationId,
-    fromDate,
-    toDate,
-    pageSize,
-  } = {}) {
-    const paginator = new Paginator();
-    const callback = async () => {
-      const pageId = paginator.nextId;
-      const pageNo = paginator.pageNo;
-      const pageType = "number";
-      const data = await this.getAbandonCartList({
-        companyId: companyId,
-        applicationId: applicationId,
-        fromDate: fromDate,
-        toDate: toDate,
-        pageNo: pageNo,
-        pageSize: pageSize,
-      });
-      paginator.setPaginator({
-        hasNext: data.page.has_next ? true : false,
-        nextId: data.page.next_id,
+    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",
       });
-      return data;
-    };
-    paginator.setCallback(callback.bind(this));
-    return paginator;
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.fromDate - From date
-   * @param {string} arg.toDate - To date
-   * @summary: Get abandon carts csv
-   * @description: Get abandon carts csv
+   * @param {string} arg.groupName - Group name
+   * @returns {Promise<StatsGroupComponents>} - Success response
+   * @summary: Get statistics group components
+   * @description: Get statistics group components
    */
-  getAbandonCartsCSV({ fromDate, toDate } = {}) {
-    const { error } = AnalyticsValidator.getAbandonCartsCSV().validate(
+  async getStatiscticsGroupComponents({ groupName } = {}) {
+    const {
+      error,
+    } = AnalyticsValidator.getStatiscticsGroupComponents().validate(
       {
-        fromDate,
-        toDate,
+        groupName,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -331,40 +453,59 @@ class Analytics {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = AnalyticsValidator.getAbandonCartsCSV().validate(
+    } = AnalyticsValidator.getStatiscticsGroupComponents().validate(
       {
-        fromDate,
-        toDate,
+        groupName,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getAbandonCartsCSV");
-      console.log(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}/cart/${fromDate}/to/${toDate}/abandon-cart.csv`,
+      `/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.cartId - Cart Id
-   * @summary: Get abandon carts details
-   * @description: Get abandon cart details
+   * @returns {Promise<StatsGroups>} - Success response
+   * @summary: Get statistics groups
+   * @description: Get statistics groups
    */
-  getAbandonCartDetail({ cartId } = {}) {
-    const { error } = AnalyticsValidator.getAbandonCartDetail().validate(
-      {
-        cartId,
-      },
+  async getStatiscticsGroups({} = {}) {
+    const { error } = AnalyticsValidator.getStatiscticsGroups().validate(
+      {},
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -374,26 +515,42 @@ class Analytics {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = AnalyticsValidator.getAbandonCartDetail().validate(
-      {
-        cartId,
-      },
+    } = AnalyticsValidator.getStatiscticsGroups().validate(
+      {},
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getAbandonCartDetail");
-      console.log(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}/cart/abandon-cart/${cartId}`,
+      `/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;
   }
 }
 module.exports = Analytics;