@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

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,
@@ -26,11 +30,27 @@ class Analytics {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = AnalyticsValidator.createExportJob().validate(
+      {
+        exportType,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (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}`,
@@ -38,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,
@@ -59,11 +97,29 @@ class Analytics {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = AnalyticsValidator.getExportJobStatus().validate(
+      {
+        exportType,
+        jobId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (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}`,
@@ -71,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;
   }
 
   /**
@@ -79,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,
@@ -96,13 +170,31 @@ class Analytics {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = AnalyticsValidator.getLogsList().validate(
+      {
+        logType,
+        body,
+        pageNo,
+        pageSize,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getLogsList",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["page_no"] = pageNo;
     query_params["page_size"] = pageSize;
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/analytics/v1.0/company/${this.config.companyId}/logs/${logType}`,
@@ -110,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;
   }
 
   /**
@@ -148,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,
@@ -165,13 +275,31 @@ class Analytics {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = AnalyticsValidator.searchLogs().validate(
+      {
+        logType,
+        body,
+        pageNo,
+        pageSize,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for searchLogs",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["page_no"] = pageNo;
     query_params["page_size"] = pageSize;
 
     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`,
@@ -179,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/AuditTrail/AuditTrailPlatformClient.d.ts

@@ -5,34 +5,38 @@ declare class AuditTrail {
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.qs - Logs Query
+     * @returns {Promise<LogSchemaResponse>} - Success response
      * @summary: Get paginated audit logs
      * @description: Get a paginated set of logs that can be filtered using the available set of parameters and get the relevant group of logs
      */
     getAuditLogs({ qs }?: {
         qs: string;
-    }): Promise<any>;
+    }): Promise<LogSchemaResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {RequestBodyAuditLog} arg.body
+     * @returns {Promise<CreateLogResponse>} - Success response
      * @summary: Create logs for auditing later on
      * @description: Create a log instance that stores all the relevant info to be logged
      */
     createAuditLog({ body }?: {
         body: RequestBodyAuditLog;
-    }): Promise<any>;
+    }): Promise<CreateLogResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Log uuid
+     * @returns {Promise<LogSchemaResponse>} - Success response
      * @summary: Get audit log
      * @description: Get detailed log information by their id
      */
     getAuditLog({ id }?: {
         id: string;
-    }): Promise<any>;
+    }): Promise<LogSchemaResponse>;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<EntityTypesResponse>} - Success response
      * @summary: Get entity types
      * @description: Get a consolidated list of entity types from all the logs stored on the db, which further helps to filter the logs better
      */
-    getEntityTypes({}?: any): Promise<any>;
+    getEntityTypes({}?: any): Promise<EntityTypesResponse>;
 }

package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js

@@ -2,6 +2,9 @@ const Paginator = require("../../common/Paginator");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const AuditTrailValidator = require("./AuditTrailPlatformValidator");
+const AuditTrailModel = require("./AuditTrailPlatformModel");
+const { Logger } = require("./../../common/Logger");
+
 class AuditTrail {
   constructor(config) {
     this.config = config;
@@ -10,10 +13,11 @@ class AuditTrail {
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.qs - Logs Query
+   * @returns {Promise<LogSchemaResponse>} - Success response
    * @summary: Get paginated audit logs
    * @description: Get a paginated set of logs that can be filtered using the available set of parameters and get the relevant group of logs
    */
-  getAuditLogs({ qs } = {}) {
+  async getAuditLogs({ qs } = {}) {
     const { error } = AuditTrailValidator.getAuditLogs().validate(
       {
         qs,
@@ -24,12 +28,27 @@ class AuditTrail {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = AuditTrailValidator.getAuditLogs().validate(
+      {
+        qs,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getAuditLogs",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["qs"] = qs;
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/`,
@@ -37,15 +56,33 @@ class AuditTrail {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = AuditTrailModel.LogSchemaResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getAuditLogs",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {RequestBodyAuditLog} arg.body
+   * @returns {Promise<CreateLogResponse>} - Success response
    * @summary: Create logs for auditing later on
    * @description: Create a log instance that stores all the relevant info to be logged
    */
-  createAuditLog({ body } = {}) {
+  async createAuditLog({ body } = {}) {
     const { error } = AuditTrailValidator.createAuditLog().validate(
       {
         body,
@@ -56,11 +93,26 @@ class AuditTrail {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = AuditTrailValidator.createAuditLog().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for createAuditLog",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/`,
@@ -68,15 +120,33 @@ class AuditTrail {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = AuditTrailModel.CreateLogResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for createAuditLog",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.id - Log uuid
+   * @returns {Promise<LogSchemaResponse>} - Success response
    * @summary: Get audit log
    * @description: Get detailed log information by their id
    */
-  getAuditLog({ id } = {}) {
+  async getAuditLog({ id } = {}) {
     const { error } = AuditTrailValidator.getAuditLog().validate(
       {
         id,
@@ -87,11 +157,26 @@ class AuditTrail {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = AuditTrailValidator.getAuditLog().validate(
+      {
+        id,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getAuditLog",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/${id}`,
@@ -99,14 +184,32 @@ class AuditTrail {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = AuditTrailModel.LogSchemaResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getAuditLog",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
+   * @returns {Promise<EntityTypesResponse>} - Success response
    * @summary: Get entity types
    * @description: Get a consolidated list of entity types from all the logs stored on the db, which further helps to filter the logs better
    */
-  getEntityTypes({} = {}) {
+  async getEntityTypes({} = {}) {
     const { error } = AuditTrailValidator.getEntityTypes().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -115,11 +218,24 @@ class AuditTrail {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = AuditTrailValidator.getEntityTypes().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getEntityTypes",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/audit-trail/v1.0/company/${this.config.companyId}/entity-types`,
@@ -127,6 +243,23 @@ class AuditTrail {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = AuditTrailModel.EntityTypesResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getEntityTypes",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 }