@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

package/sdk/platform/Inventory/InventoryPlatformClient.js

@@ -2,6 +2,9 @@ const Paginator = require("../../common/Paginator");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const InventoryValidator = require("./InventoryPlatformValidator");
+const InventoryModel = require("./InventoryPlatformModel");
+const { Logger } = require("./../../common/Logger");
+
 class Inventory {
   constructor(config) {
     this.config = config;
@@ -11,10 +14,11 @@ class Inventory {
    * @param {Object} arg - Arg object.
    * @param {number} [arg.pageNo] - Page Number
    * @param {number} [arg.pageSize] - Page Size
+   * @returns {Promise<ResponseEnvelopeListJobConfigRawDTO>} - Success response
    * @summary: Get Job Configs For A Company
    * @description: REST Endpoint that returns all job configs for a company
    */
-  getJobsByCompany({ pageNo, pageSize } = {}) {
+  async getJobsByCompany({ pageNo, pageSize } = {}) {
     const { error } = InventoryValidator.getJobsByCompany().validate(
       {
         pageNo,
@@ -26,13 +30,29 @@ class Inventory {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = InventoryValidator.getJobsByCompany().validate(
+      {
+        pageNo,
+        pageSize,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getJobsByCompany",
+      });
+      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,
       "get",
       `/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs`,
@@ -40,15 +60,33 @@ class Inventory {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = InventoryModel.ResponseEnvelopeListJobConfigRawDTO().validate(
+      response,
+      { abortEarly: false, allowUnknown: false }
+    );
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getJobsByCompany",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {JobConfigDTO} arg.body
+   * @returns {Promise<ResponseEnvelopeString>} - Success response
    * @summary: Updates An Existing Job Config
    * @description: REST Endpoint that updates a job config
    */
-  updateJob({ body } = {}) {
+  async updateJob({ body } = {}) {
     const { error } = InventoryValidator.updateJob().validate(
       {
         body,
@@ -59,11 +97,26 @@ class Inventory {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = InventoryValidator.updateJob().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for updateJob",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "put",
       `/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs`,
@@ -71,15 +124,33 @@ class Inventory {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = InventoryModel.ResponseEnvelopeString().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for updateJob",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {JobConfigDTO} arg.body
+   * @returns {Promise<ResponseEnvelopeString>} - Success response
    * @summary: Creates A New Job Config
    * @description: REST Endpoint that creates a new job config
    */
-  createJob({ body } = {}) {
+  async createJob({ body } = {}) {
     const { error } = InventoryValidator.createJob().validate(
       {
         body,
@@ -90,11 +161,26 @@ class Inventory {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = InventoryValidator.createJob().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for createJob",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs`,
@@ -102,15 +188,33 @@ class Inventory {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = InventoryModel.ResponseEnvelopeString().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for createJob",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {SuppressStorePayload} arg.body
+   * @returns {Promise<ResponseEnvelopeKafkaResponse>} - Success response
    * @summary: Get Slingshot Configuration Of  A Company
    * @description: REST Endpoint that returns all configuration detail of a company
    */
-  suppressStores({ body } = {}) {
+  async suppressStores({ body } = {}) {
     const { error } = InventoryValidator.suppressStores().validate(
       {
         body,
@@ -121,11 +225,26 @@ class Inventory {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = InventoryValidator.suppressStores().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for suppressStores",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/inventory/v1.0/company/${this.config.companyId}/kafka/suppressStore`,
@@ -133,14 +252,33 @@ class Inventory {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = InventoryModel.ResponseEnvelopeKafkaResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for suppressStores",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
+   * @returns {Promise<ResponseEnvelopeListSlingshotConfigurationDetail>} -
+   *   Success response
    * @summary: Get Slingshot Configuration Of  A Company
    * @description: REST Endpoint that returns all configuration detail of a company
    */
-  getConfigByCompany({} = {}) {
+  async getConfigByCompany({} = {}) {
     const { error } = InventoryValidator.getConfigByCompany().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -149,11 +287,26 @@ class Inventory {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = InventoryValidator.getConfigByCompany().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getConfigByCompany",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/inventory/v1.0/company/${this.config.companyId}/slingshot`,
@@ -161,15 +314,33 @@ class Inventory {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = InventoryModel.ResponseEnvelopeListSlingshotConfigurationDetail().validate(
+      response,
+      { abortEarly: false, allowUnknown: false }
+    );
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getConfigByCompany",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {number} arg.jobId - Job Id
+   * @returns {Promise<ResponseEnvelopeListJobStepsDTO>} - Success response
    * @summary: Get Job Code Steps
    * @description: REST Endpoint that returns Inventory Job Steps
    */
-  getJobSteps({ jobId } = {}) {
+  async getJobSteps({ jobId } = {}) {
     const { error } = InventoryValidator.getJobSteps().validate(
       {
         jobId,
@@ -180,11 +351,26 @@ class Inventory {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = InventoryValidator.getJobSteps().validate(
+      {
+        jobId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getJobSteps",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs/steps/${jobId}`,
@@ -192,6 +378,23 @@ class Inventory {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = InventoryModel.ResponseEnvelopeListJobStepsDTO().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getJobSteps",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -199,10 +402,15 @@ class Inventory {
    * @param {string} arg.integrationId - Integration Id
    * @param {number} [arg.pageNo] - Page Number
    * @param {number} [arg.pageSize] - Page Size
+   * @returns {Promise<ResponseEnvelopeListJobConfigDTO>} - Success response
    * @summary: Get Job Configs By Company And Integration
    * @description: REST Endpoint that returns all job configs by company And integration
    */
-  getJobByCompanyAndIntegration({ integrationId, pageNo, pageSize } = {}) {
+  async getJobByCompanyAndIntegration({
+    integrationId,
+    pageNo,
+    pageSize,
+  } = {}) {
     const {
       error,
     } = InventoryValidator.getJobByCompanyAndIntegration().validate(
@@ -217,13 +425,33 @@ class Inventory {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = InventoryValidator.getJobByCompanyAndIntegration().validate(
+      {
+        integrationId,
+        pageNo,
+        pageSize,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message:
+          "Parameter Validation warrnings for getJobByCompanyAndIntegration",
+      });
+      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,
       "get",
       `/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs/integration/${integrationId}`,
@@ -231,15 +459,34 @@ class Inventory {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = InventoryModel.ResponseEnvelopeListJobConfigDTO().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message:
+          "Response Validation Warnnings for getJobByCompanyAndIntegration",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.integrationId - IntegrationId
+   * @returns {Promise<ResponseEnvelopeString>} - Success response
    * @summary: Disable Job Config
    * @description: REST Endpoint that disables Inventory Job Config
    */
-  disable({ integrationId } = {}) {
+  async disable({ integrationId } = {}) {
     const { error } = InventoryValidator.disable().validate(
       {
         integrationId,
@@ -250,11 +497,26 @@ class Inventory {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = InventoryValidator.disable().validate(
+      {
+        integrationId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for disable",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs/disable/integration/${integrationId}`,
@@ -262,14 +524,32 @@ class Inventory {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = InventoryModel.ResponseEnvelopeString().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for disable",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
+   * @returns {Promise<ResponseEnvelopeJobConfigDTO>} - Success response
    * @summary: Get Job Configs Defaults
    * @description: REST Endpoint that returns default fields job configs by company And integration
    */
-  getJobConfigDefaults({} = {}) {
+  async getJobConfigDefaults({} = {}) {
     const { error } = InventoryValidator.getJobConfigDefaults().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -278,11 +558,26 @@ class Inventory {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = InventoryValidator.getJobConfigDefaults().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getJobConfigDefaults",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs/defaults`,
@@ -290,15 +585,33 @@ class Inventory {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = InventoryModel.ResponseEnvelopeJobConfigDTO().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getJobConfigDefaults",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.code - Job Code
+   * @returns {Promise<ResponseEnvelopeJobConfigDTO>} - Success response
    * @summary: Get Job Config By Code
    * @description: REST Endpoint that returns job config by code
    */
-  getJobByCode({ code } = {}) {
+  async getJobByCode({ code } = {}) {
     const { error } = InventoryValidator.getJobByCode().validate(
       {
         code,
@@ -309,11 +622,26 @@ class Inventory {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = InventoryValidator.getJobByCode().validate(
+      {
+        code,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getJobByCode",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs/code/${code}`,
@@ -321,6 +649,23 @@ class Inventory {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = InventoryModel.ResponseEnvelopeJobConfigDTO().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getJobByCode",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -330,10 +675,11 @@ class Inventory {
    * @param {number} [arg.pageSize] - Page Size
    * @param {string} [arg.status] - Status
    * @param {string} [arg.date] - From Date
+   * @returns {Promise<ResponseEnvelopeJobMetricsDto>} - Success response
    * @summary: Get Job Metrics
    * @description: REST Endpoint that returns Inventory Run History For A Job Code
    */
-  getJobCodeMetrics({ code, pageNo, pageSize, status, date } = {}) {
+  async getJobCodeMetrics({ code, pageNo, pageSize, status, date } = {}) {
     const { error } = InventoryValidator.getJobCodeMetrics().validate(
       {
         code,
@@ -348,6 +694,25 @@ class Inventory {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = InventoryValidator.getJobCodeMetrics().validate(
+      {
+        code,
+        pageNo,
+        pageSize,
+        status,
+        date,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getJobCodeMetrics",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["page_no"] = pageNo;
     query_params["page_size"] = pageSize;
@@ -356,7 +721,7 @@ class Inventory {
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs/code/${code}/metrics`,
@@ -364,6 +729,23 @@ class Inventory {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = InventoryModel.ResponseEnvelopeJobMetricsDto().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getJobCodeMetrics",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -371,10 +753,15 @@ class Inventory {
    * @param {string} arg.integrationId - Integration Id
    * @param {number} [arg.pageNo] - Page Number
    * @param {number} [arg.pageSize] - Page Size
+   * @returns {Promise<ResponseEnvelopeListJobConfigListDTO>} - Success response
    * @summary: Get Job Codes By Company And Integration
    * @description: REST Endpoint that returns all job codes by company And integration
    */
-  getJobCodesByCompanyAndIntegration({ integrationId, pageNo, pageSize } = {}) {
+  async getJobCodesByCompanyAndIntegration({
+    integrationId,
+    pageNo,
+    pageSize,
+  } = {}) {
     const {
       error,
     } = InventoryValidator.getJobCodesByCompanyAndIntegration().validate(
@@ -389,13 +776,33 @@ class Inventory {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = InventoryValidator.getJobCodesByCompanyAndIntegration().validate(
+      {
+        integrationId,
+        pageNo,
+        pageSize,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message:
+          "Parameter Validation warrnings for getJobCodesByCompanyAndIntegration",
+      });
+      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,
       "get",
       `/service/platform/inventory/v1.0/company/${this.config.companyId}/jobs/code/integration/${integrationId}`,
@@ -403,6 +810,24 @@ class Inventory {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = InventoryModel.ResponseEnvelopeListJobConfigListDTO().validate(
+      response,
+      { abortEarly: false, allowUnknown: false }
+    );
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message:
+          "Response Validation Warnnings for getJobCodesByCompanyAndIntegration",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 }