@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

package/sdk/public/Inventory/InventoryPublicClient.js

@@ -3,19 +3,22 @@ const { FDKClientValidationError } = require("../../common/FDKError");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
 const InventoryValidator = require("./InventoryPublicValidator");
+const InventoryModel = require("./InventoryPublicModel");
+const { Logger } = require("./../../common/Logger");
+
 class Inventory {
   constructor(_conf) {
     this._conf = _conf;
     this._relativeUrls = {
-      getJobCodesMetrics:
-        "/service/common/inventory/v1.0/company/email/jobCode",
-      saveJobCodesMetrics:
-        "/service/common/inventory/v1.0/company/email/jobCode",
-      getConfigByApiKey: "/service/common/inventory/v1.0/company/slingshot",
       getApiKey: "/service/common/inventory/v1.0/company/slingshot/apikey",
+      getConfigByApiKey: "/service/common/inventory/v1.0/company/slingshot",
       getJobByCode: "/service/common/inventory/v1.0/company/jobs/code/{code}",
+      getJobCodesMetrics:
+        "/service/common/inventory/v1.0/company/email/jobCode",
       getJobConfigByIntegrationType:
         "/service/common/inventory/v1.0/company/job/config",
+      saveJobCodesMetrics:
+        "/service/common/inventory/v1.0/company/email/jobCode",
     };
     this._urls = Object.entries(this._relativeUrls).reduce(
       (urls, [method, relativeUrl]) => {
@@ -35,15 +38,15 @@ class Inventory {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {boolean} [arg.dailyJob] - Daily Job Flag
-   * @param {string} [arg.jobCode] - Email Job Code
-   * @returns {Promise<ResponseEnvelopeObject>} - Success response
-   * @summary: Find all the JobCodes from Metrics Collection based on the field Values
-   * @description: Endpoint to return all JobCodes present in Metrics Collection
+   * @param {string} arg.userName - Integration id
+   * @param {string} arg.password - Company/store token
+   * @returns {Promise<ResponseEnvelopeApikeyModel>} - Success response
+   * @summary: Get apikey  for  Company  to call other Slingshot Configuration APIs
+   * @description: REST Endpoint that returns apikey by username by password
    */
-  getJobCodesMetrics({ dailyJob, jobCode } = {}) {
-    const { error } = InventoryValidator.getJobCodesMetrics().validate(
-      { dailyJob, jobCode },
+  async getApiKey({ userName, password } = {}) {
+    const { error } = InventoryValidator.getApiKey().validate(
+      { userName, password },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -51,79 +54,52 @@ class Inventory {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = InventoryValidator.getJobCodesMetrics().validate(
-      { dailyJob, jobCode },
+    const { error: warrning } = InventoryValidator.getApiKey().validate(
+      { userName, password },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getJobCodesMetrics");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getApiKey",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
-    query_params["daily_job"] = dailyJob;
-    query_params["job_code"] = jobCode;
+    query_params["user_name"] = userName;
+    query_params["password"] = password;
 
     const xHeaders = {};
 
-    return PublicAPIClient.execute(
+    const response = await PublicAPIClient.execute(
       this._conf,
       "get",
       constructUrl({
-        url: this._urls["getJobCodesMetrics"],
+        url: this._urls["getApiKey"],
         params: {},
       }),
       query_params,
       undefined,
       xHeaders
     );
-  }
-
-  /**
-   * @param {Object} arg - Arg object.
-   * @param {EmailJobMetrics} arg.body
-   * @returns {Promise<ResponseEnvelopeEmailJobMetrics>} - Success response
-   * @summary: Save JobCode Metrics
-   * @description: Endpoint to save JobCode Metrics
-   */
-  saveJobCodesMetrics({ body } = {}) {
-    const { error } = InventoryValidator.saveJobCodesMetrics().validate(
-      { body },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
 
-    // Showing warrnings if extra unknown parameters are found
     const {
-      error: warrning,
-    } = InventoryValidator.saveJobCodesMetrics().validate(
-      { body },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      console.log("Parameter Validation warrnings for saveJobCodesMetrics");
-      console.log(warrning);
-    }
-
-    const query_params = {};
+      error: res_error,
+    } = InventoryModel.ResponseEnvelopeApikeyModel().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
 
-    const xHeaders = {};
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getApiKey",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
 
-    return PublicAPIClient.execute(
-      this._conf,
-      "post",
-      constructUrl({
-        url: this._urls["saveJobCodesMetrics"],
-        params: {},
-      }),
-      query_params,
-      body,
-      xHeaders
-    );
+    return response;
   }
 
   /**
@@ -133,7 +109,7 @@ class Inventory {
    * @summary: Get Slingshot Configuration Of  A Company using API key
    * @description: REST Endpoint that returns all configuration detail of a company
    */
-  getConfigByApiKey({ apikey } = {}) {
+  async getConfigByApiKey({ apikey } = {}) {
     const { error } = InventoryValidator.getConfigByApiKey().validate(
       { apikey },
       { abortEarly: false, allowUnknown: true }
@@ -148,8 +124,11 @@ class Inventory {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getConfigByApiKey");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getConfigByApiKey",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -157,7 +136,7 @@ class Inventory {
 
     const xHeaders = {};
 
-    return PublicAPIClient.execute(
+    const response = await PublicAPIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -168,19 +147,35 @@ class Inventory {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = InventoryModel.ResponseEnvelopeSlingshotConfigurationDetail().validate(
+      response,
+      { abortEarly: false, allowUnknown: false }
+    );
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getConfigByApiKey",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.userName - Integration id
-   * @param {string} arg.password - Company/store token
-   * @returns {Promise<ResponseEnvelopeApikeyModel>} - Success response
-   * @summary: Get apikey  for  Company  to call other Slingshot Configuration APIs
-   * @description: REST Endpoint that returns apikey by username by password
+   * @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
    */
-  getApiKey({ userName, password } = {}) {
-    const { error } = InventoryValidator.getApiKey().validate(
-      { userName, password },
+  async getJobByCode({ code } = {}) {
+    const { error } = InventoryValidator.getJobByCode().validate(
+      { code },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -188,44 +183,63 @@ class Inventory {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = InventoryValidator.getApiKey().validate(
-      { userName, password },
+    const { error: warrning } = InventoryValidator.getJobByCode().validate(
+      { code },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getApiKey");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getJobByCode",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
-    query_params["user_name"] = userName;
-    query_params["password"] = password;
 
     const xHeaders = {};
 
-    return PublicAPIClient.execute(
+    const response = await PublicAPIClient.execute(
       this._conf,
       "get",
       constructUrl({
-        url: this._urls["getApiKey"],
-        params: {},
+        url: this._urls["getJobByCode"],
+        params: { code },
       }),
       query_params,
       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;
   }
 
   /**
    * @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
+   * @param {boolean} [arg.dailyJob] - Daily Job Flag
+   * @param {string} [arg.jobCode] - Email Job Code
+   * @returns {Promise<ResponseEnvelopeObject>} - Success response
+   * @summary: Find all the JobCodes from Metrics Collection based on the field Values
+   * @description: Endpoint to return all JobCodes present in Metrics Collection
    */
-  getJobByCode({ code } = {}) {
-    const { error } = InventoryValidator.getJobByCode().validate(
-      { code },
+  async getJobCodesMetrics({ dailyJob, jobCode } = {}) {
+    const { error } = InventoryValidator.getJobCodesMetrics().validate(
+      { dailyJob, jobCode },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -233,30 +247,54 @@ class Inventory {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = InventoryValidator.getJobByCode().validate(
-      { code },
+    const {
+      error: warrning,
+    } = InventoryValidator.getJobCodesMetrics().validate(
+      { dailyJob, jobCode },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getJobByCode");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getJobCodesMetrics",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
+    query_params["daily_job"] = dailyJob;
+    query_params["job_code"] = jobCode;
 
     const xHeaders = {};
 
-    return PublicAPIClient.execute(
+    const response = await PublicAPIClient.execute(
       this._conf,
       "get",
       constructUrl({
-        url: this._urls["getJobByCode"],
-        params: { code },
+        url: this._urls["getJobCodesMetrics"],
+        params: {},
       }),
       query_params,
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = InventoryModel.ResponseEnvelopeObject().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getJobCodesMetrics",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -267,7 +305,7 @@ class Inventory {
    * @summary: Get Job Configs By Integration Type
    * @description: REST Endpoint that returns all job Configs by Integration Type
    */
-  getJobConfigByIntegrationType({ integrationType, disable } = {}) {
+  async getJobConfigByIntegrationType({ integrationType, disable } = {}) {
     const {
       error,
     } = InventoryValidator.getJobConfigByIntegrationType().validate(
@@ -286,10 +324,12 @@ class Inventory {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log(
-        "Parameter Validation warrnings for getJobConfigByIntegrationType"
-      );
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message:
+          "Parameter Validation warrnings for getJobConfigByIntegrationType",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -298,7 +338,7 @@ class Inventory {
 
     const xHeaders = {};
 
-    return PublicAPIClient.execute(
+    const response = await PublicAPIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -309,6 +349,89 @@ 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 getJobConfigByIntegrationType",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {EmailJobMetrics} arg.body
+   * @returns {Promise<ResponseEnvelopeEmailJobMetrics>} - Success response
+   * @summary: Save JobCode Metrics
+   * @description: Endpoint to save JobCode Metrics
+   */
+  async saveJobCodesMetrics({ body } = {}) {
+    const { error } = InventoryValidator.saveJobCodesMetrics().validate(
+      { body },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = InventoryValidator.saveJobCodesMetrics().validate(
+      { body },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for saveJobCodesMetrics",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PublicAPIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["saveJobCodesMetrics"],
+        params: {},
+      }),
+      query_params,
+      body,
+      xHeaders
+    );
+
+    const {
+      error: res_error,
+    } = InventoryModel.ResponseEnvelopeEmailJobMetrics().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for saveJobCodesMetrics",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 }
 module.exports = Inventory;

package/sdk/public/Inventory/InventoryPublicModel.d.ts

@@ -1,22 +1,22 @@
 export = InventoryModel;
 declare class InventoryModel {
+    static ApikeyModel(): any;
+    static DataTresholdDTO(): any;
     static EmailJobMetrics(): any;
-    static Page(): any;
-    static ResponseEnvelopeEmailJobMetrics(): any;
     static GCompany(): any;
+    static GenericDTO(): any;
     static GStore(): any;
+    static JobConfigDTO(): any;
     static Metum(): any;
+    static Page(): any;
+    static ResponseEnvelopeApikeyModel(): any;
+    static ResponseEnvelopeEmailJobMetrics(): any;
+    static ResponseEnvelopeJobConfigDTO(): any;
+    static ResponseEnvelopeListJobConfigDTO(): any;
+    static ResponseEnvelopeObject(): any;
     static ResponseEnvelopeSlingshotConfigurationDetail(): any;
     static SlingshotConfigurationDetail(): any;
     static SlingshotIntegration(): any;
     static StoreData(): any;
-    static ApikeyModel(): any;
-    static ResponseEnvelopeApikeyModel(): any;
-    static DataTresholdDTO(): any;
-    static GenericDTO(): any;
-    static JobConfigDTO(): any;
-    static ResponseEnvelopeJobConfigDTO(): any;
     static TaskDTO(): any;
-    static ResponseEnvelopeListJobConfigDTO(): any;
-    static ResponseEnvelopeObject(): any;
 }