@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

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

@@ -1,11 +1,11 @@
 export = AnalyticsValidator;
 declare class AnalyticsValidator {
-    static getStatiscticsGroups(): any;
-    static getStatiscticsGroupComponents(): any;
-    static getComponentStatsCSV(): any;
-    static getComponentStatsPDF(): any;
-    static getComponentStats(): any;
+    static getAbandonCartDetail(): any;
     static getAbandonCartList(): any;
     static getAbandonCartsCSV(): any;
-    static getAbandonCartDetail(): any;
+    static getComponentStats(): any;
+    static getComponentStatsCSV(): any;
+    static getComponentStatsPDF(): any;
+    static getStatiscticsGroupComponents(): any;
+    static getStatiscticsGroups(): any;
 }

package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js

@@ -2,25 +2,25 @@ const Joi = require("joi");
 const AnalyticsModel = require("./AnalyticsPlatformModel");
 
 class AnalyticsValidator {
-  static getStatiscticsGroups() {
-    return Joi.object({}).required();
-  }
-
-  static getStatiscticsGroupComponents() {
+  static getAbandonCartDetail() {
     return Joi.object({
-      groupName: Joi.string().allow("").required(),
+      cartId: Joi.string().allow("").required(),
     }).required();
   }
 
-  static getComponentStatsCSV() {
+  static getAbandonCartList() {
     return Joi.object({
-      componentName: Joi.string().allow("").required(),
+      fromDate: Joi.string().allow("").required(),
+      toDate: Joi.string().allow("").required(),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
     }).required();
   }
 
-  static getComponentStatsPDF() {
+  static getAbandonCartsCSV() {
     return Joi.object({
-      componentName: Joi.string().allow("").required(),
+      fromDate: Joi.string().allow("").required(),
+      toDate: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -30,27 +30,27 @@ class AnalyticsValidator {
     }).required();
   }
 
-  static getAbandonCartList() {
+  static getComponentStatsCSV() {
     return Joi.object({
-      fromDate: Joi.string().allow("").required(),
-      toDate: Joi.string().allow("").required(),
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
+      componentName: Joi.string().allow("").required(),
     }).required();
   }
 
-  static getAbandonCartsCSV() {
+  static getComponentStatsPDF() {
     return Joi.object({
-      fromDate: Joi.string().allow("").required(),
-      toDate: Joi.string().allow("").required(),
+      componentName: Joi.string().allow("").required(),
     }).required();
   }
 
-  static getAbandonCartDetail() {
+  static getStatiscticsGroupComponents() {
     return Joi.object({
-      cartId: Joi.string().allow("").required(),
+      groupName: Joi.string().allow("").required(),
     }).required();
   }
+
+  static getStatiscticsGroups() {
+    return Joi.object({}).required();
+  }
 }
 
 module.exports = AnalyticsValidator;

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

package/sdk/platform/Analytics/AnalyticsPlatformClient.js

@@ -2,6 +2,9 @@ const Paginator = require("../../common/Paginator");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const AnalyticsValidator = require("./AnalyticsPlatformValidator");
+const AnalyticsModel = require("./AnalyticsPlatformModel");
+const { Logger } = require("./../../common/Logger");
+
 class Analytics {
   constructor(config) {
     this.config = config;
@@ -11,10 +14,11 @@ 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 } = {}) {
+  async createExportJob({ exportType, body } = {}) {
     const { error } = AnalyticsValidator.createExportJob().validate(
       {
         exportType,
@@ -35,15 +39,18 @@ class Analytics {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for createExportJob");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for createExportJob",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/analytics/v1.0/company/${this.config.companyId}/export/${exportType}`,
@@ -51,16 +58,34 @@ class Analytics {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = AnalyticsModel.ExportJobRes().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for createExportJob",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @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 } = {}) {
+  async getExportJobStatus({ exportType, jobId } = {}) {
     const { error } = AnalyticsValidator.getExportJobStatus().validate(
       {
         exportType,
@@ -83,15 +108,18 @@ class Analytics {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getExportJobStatus");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getExportJobStatus",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/analytics/v1.0/company/${this.config.companyId}/export/${exportType}/job/${jobId}`,
@@ -99,6 +127,23 @@ class Analytics {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = AnalyticsModel.ExportJobStatusRes().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getExportJobStatus",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -107,10 +152,11 @@ class Analytics {
    * @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
    */
-  getLogsList({ logType, body, pageNo, pageSize } = {}) {
+  async getLogsList({ logType, body, pageNo, pageSize } = {}) {
     const { error } = AnalyticsValidator.getLogsList().validate(
       {
         logType,
@@ -135,8 +181,11 @@ class Analytics {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getLogsList");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getLogsList",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -145,7 +194,7 @@ class Analytics {
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/analytics/v1.0/company/${this.config.companyId}/logs/${logType}`,
@@ -153,6 +202,23 @@ class Analytics {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = AnalyticsModel.GetLogsListRes().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getLogsList",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -191,10 +257,11 @@ 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
    */
-  searchLogs({ logType, body, pageNo, pageSize } = {}) {
+  async searchLogs({ logType, body, pageNo, pageSize } = {}) {
     const { error } = AnalyticsValidator.searchLogs().validate(
       {
         logType,
@@ -219,8 +286,11 @@ class Analytics {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for searchLogs");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for searchLogs",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -229,7 +299,7 @@ class Analytics {
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/analytics/v1.0/company/${this.config.companyId}/logs/${logType}/search`,
@@ -237,6 +307,23 @@ class Analytics {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = AnalyticsModel.SearchLogRes().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for searchLogs",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**

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

@@ -1,23 +1,23 @@
 export = AnalyticsModel;
 declare class AnalyticsModel {
-    static StatGroup(): any;
-    static ErrorRes(): any;
-    static StatsGroups(): any;
-    static StatsGroupComponent(): any;
-    static StatsGroupComponents(): any;
-    static StatsRes(): any;
-    static ReceivedAt(): any;
+    static AbandonCartDetail(): any;
     static AbandonCartsDetail(): any;
-    static Page(): any;
     static AbandonCartsList(): any;
-    static AbandonCartDetail(): any;
+    static ErrorRes(): any;
     static ExportJobReq(): any;
     static ExportJobRes(): any;
     static ExportJobStatusRes(): any;
     static GetLogsListReq(): any;
-    static MkpLogsResp(): any;
     static GetLogsListRes(): any;
-    static SearchLogReq(): any;
     static LogInfo(): any;
+    static MkpLogsResp(): any;
+    static Page(): any;
+    static ReceivedAt(): any;
+    static SearchLogReq(): any;
     static SearchLogRes(): any;
+    static StatGroup(): any;
+    static StatsGroupComponent(): any;
+    static StatsGroupComponents(): any;
+    static StatsGroups(): any;
+    static StatsRes(): any;
 }