@gofynd/fdk-client-javascript 1.0.2 → 1.0.4

package/sdk/public/Inventory/InventoryPublicClient.js

@@ -5,20 +5,21 @@ const Paginator = require("../../common/Paginator");
 const InventoryValidator = require("./InventoryPublicValidator");
 const InventoryModel = require("./InventoryPublicModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 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]) => {
@@ -38,15 +39,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
    */
-  async 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) {
@@ -54,23 +55,21 @@ 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) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getJobCodesMetrics",
+        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 = {};
 
@@ -78,7 +77,7 @@ class Inventory {
       this._conf,
       "get",
       constructUrl({
-        url: this._urls["getJobCodesMetrics"],
+        url: this._urls["getApiKey"],
         params: {},
       }),
       query_params,
@@ -88,7 +87,7 @@ class Inventory {
 
     const {
       error: res_error,
-    } = InventoryModel.ResponseEnvelopeObject().validate(response, {
+    } = InventoryModel.ResponseEnvelopeApikeyModel().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -96,7 +95,7 @@ class Inventory {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getJobCodesMetrics",
+        message: "Response Validation Warnnings for getApiKey",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -106,14 +105,14 @@ class Inventory {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {EmailJobMetrics} arg.body
-   * @returns {Promise<ResponseEnvelopeEmailJobMetrics>} - Success response
-   * @summary: Save JobCode Metrics
-   * @description: Endpoint to save JobCode Metrics
+   * @param {string} arg.apikey - Api key
+   * @returns {Promise<ResponseEnvelopeSlingshotConfigurationDetail>} - Success response
+   * @summary: Get Slingshot Configuration Of  A Company using API key
+   * @description: REST Endpoint that returns all configuration detail of a company
    */
-  async saveJobCodesMetrics({ body } = {}) {
-    const { error } = InventoryValidator.saveJobCodesMetrics().validate(
-      { body },
+  async getConfigByApiKey({ apikey } = {}) {
+    const { error } = InventoryValidator.getConfigByApiKey().validate(
+      { apikey },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -121,47 +120,46 @@ class Inventory {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = InventoryValidator.saveJobCodesMetrics().validate(
-      { body },
+    const { error: warrning } = InventoryValidator.getConfigByApiKey().validate(
+      { apikey },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for saveJobCodesMetrics",
+        message: "Parameter Validation warrnings for getConfigByApiKey",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
+    query_params["apikey"] = apikey;
 
     const xHeaders = {};
 
     const response = await PublicAPIClient.execute(
       this._conf,
-      "post",
+      "get",
       constructUrl({
-        url: this._urls["saveJobCodesMetrics"],
+        url: this._urls["getConfigByApiKey"],
         params: {},
       }),
       query_params,
-      body,
+      undefined,
       xHeaders
     );
 
     const {
       error: res_error,
-    } = InventoryModel.ResponseEnvelopeEmailJobMetrics().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = InventoryModel.ResponseEnvelopeSlingshotConfigurationDetail().validate(
+      response,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for saveJobCodesMetrics",
+        message: "Response Validation Warnnings for getConfigByApiKey",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -171,14 +169,14 @@ class Inventory {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.apikey - Api key
-   * @returns {Promise<ResponseEnvelopeSlingshotConfigurationDetail>} - Success response
-   * @summary: Get Slingshot Configuration Of  A Company using API key
-   * @description: REST Endpoint that returns all configuration detail of a company
+   * @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
    */
-  async getConfigByApiKey({ apikey } = {}) {
-    const { error } = InventoryValidator.getConfigByApiKey().validate(
-      { apikey },
+  async getJobByCode({ code } = {}) {
+    const { error } = InventoryValidator.getJobByCode().validate(
+      { code },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -186,20 +184,19 @@ class Inventory {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = InventoryValidator.getConfigByApiKey().validate(
-      { apikey },
+    const { error: warrning } = InventoryValidator.getJobByCode().validate(
+      { code },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getConfigByApiKey",
+        message: "Parameter Validation warrnings for getJobByCode",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
-    query_params["apikey"] = apikey;
 
     const xHeaders = {};
 
@@ -207,8 +204,8 @@ class Inventory {
       this._conf,
       "get",
       constructUrl({
-        url: this._urls["getConfigByApiKey"],
-        params: {},
+        url: this._urls["getJobByCode"],
+        params: { code },
       }),
       query_params,
       undefined,
@@ -217,15 +214,15 @@ class Inventory {
 
     const {
       error: res_error,
-    } = InventoryModel.ResponseEnvelopeSlingshotConfigurationDetail().validate(
-      response,
-      { abortEarly: false, allowUnknown: false }
-    );
+    } = InventoryModel.ResponseEnvelopeJobConfigDTO().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getConfigByApiKey",
+        message: "Response Validation Warnnings for getJobByCode",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -235,15 +232,15 @@ class Inventory {
 
   /**
    * @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 {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
    */
-  async getApiKey({ userName, password } = {}) {
-    const { error } = InventoryValidator.getApiKey().validate(
-      { userName, password },
+  async getJobCodesMetrics({ dailyJob, jobCode } = {}) {
+    const { error } = InventoryValidator.getJobCodesMetrics().validate(
+      { dailyJob, jobCode },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -251,21 +248,23 @@ class Inventory {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = InventoryValidator.getApiKey().validate(
-      { userName, password },
+    const {
+      error: warrning,
+    } = InventoryValidator.getJobCodesMetrics().validate(
+      { dailyJob, jobCode },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getApiKey",
+        message: "Parameter Validation warrnings for getJobCodesMetrics",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
-    query_params["user_name"] = userName;
-    query_params["password"] = password;
+    query_params["daily_job"] = dailyJob;
+    query_params["job_code"] = jobCode;
 
     const xHeaders = {};
 
@@ -273,7 +272,7 @@ class Inventory {
       this._conf,
       "get",
       constructUrl({
-        url: this._urls["getApiKey"],
+        url: this._urls["getJobCodesMetrics"],
         params: {},
       }),
       query_params,
@@ -283,7 +282,7 @@ class Inventory {
 
     const {
       error: res_error,
-    } = InventoryModel.ResponseEnvelopeApikeyModel().validate(response, {
+    } = InventoryModel.ResponseEnvelopeObject().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -291,7 +290,7 @@ class Inventory {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getApiKey",
+        message: "Response Validation Warnnings for getJobCodesMetrics",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -301,14 +300,17 @@ class Inventory {
 
   /**
    * @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 {string} arg.integrationType - Integration Type
+   * @param {boolean} [arg.disable] - JobConfig current state
+   * @returns {Promise<ResponseEnvelopeListJobConfigDTO>} - Success response
+   * @summary: Get Job Configs By Integration Type
+   * @description: REST Endpoint that returns all job Configs by Integration Type
    */
-  async getJobByCode({ code } = {}) {
-    const { error } = InventoryValidator.getJobByCode().validate(
-      { code },
+  async getJobConfigByIntegrationType({ integrationType, disable } = {}) {
+    const {
+      error,
+    } = InventoryValidator.getJobConfigByIntegrationType().validate(
+      { integrationType, disable },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -316,19 +318,24 @@ class Inventory {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = InventoryValidator.getJobByCode().validate(
-      { code },
+    const {
+      error: warrning,
+    } = InventoryValidator.getJobConfigByIntegrationType().validate(
+      { integrationType, disable },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getJobByCode",
+        message:
+          "Parameter Validation warrnings for getJobConfigByIntegrationType",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
+    query_params["integration_type"] = integrationType;
+    query_params["disable"] = disable;
 
     const xHeaders = {};
 
@@ -336,8 +343,8 @@ class Inventory {
       this._conf,
       "get",
       constructUrl({
-        url: this._urls["getJobByCode"],
-        params: { code },
+        url: this._urls["getJobConfigByIntegrationType"],
+        params: {},
       }),
       query_params,
       undefined,
@@ -346,7 +353,7 @@ class Inventory {
 
     const {
       error: res_error,
-    } = InventoryModel.ResponseEnvelopeJobConfigDTO().validate(response, {
+    } = InventoryModel.ResponseEnvelopeListJobConfigDTO().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -354,7 +361,8 @@ class Inventory {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getJobByCode",
+        message:
+          "Response Validation Warnnings for getJobConfigByIntegrationType",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -364,17 +372,14 @@ class Inventory {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.integrationType - Integration Type
-   * @param {boolean} [arg.disable] - JobConfig current state
-   * @returns {Promise<ResponseEnvelopeListJobConfigDTO>} - Success response
-   * @summary: Get Job Configs By Integration Type
-   * @description: REST Endpoint that returns all job Configs by Integration Type
+   * @param {EmailJobMetrics} arg.body
+   * @returns {Promise<ResponseEnvelopeEmailJobMetrics>} - Success response
+   * @summary: Save JobCode Metrics
+   * @description: Endpoint to save JobCode Metrics
    */
-  async getJobConfigByIntegrationType({ integrationType, disable } = {}) {
-    const {
-      error,
-    } = InventoryValidator.getJobConfigByIntegrationType().validate(
-      { integrationType, disable },
+  async saveJobCodesMetrics({ body } = {}) {
+    const { error } = InventoryValidator.saveJobCodesMetrics().validate(
+      { body },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -384,40 +389,37 @@ class Inventory {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = InventoryValidator.getJobConfigByIntegrationType().validate(
-      { integrationType, disable },
+    } = InventoryValidator.saveJobCodesMetrics().validate(
+      { body },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message:
-          "Parameter Validation warrnings for getJobConfigByIntegrationType",
+        message: "Parameter Validation warrnings for saveJobCodesMetrics",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
-    query_params["integration_type"] = integrationType;
-    query_params["disable"] = disable;
 
     const xHeaders = {};
 
     const response = await PublicAPIClient.execute(
       this._conf,
-      "get",
+      "post",
       constructUrl({
-        url: this._urls["getJobConfigByIntegrationType"],
+        url: this._urls["saveJobCodesMetrics"],
         params: {},
       }),
       query_params,
-      undefined,
+      body,
       xHeaders
     );
 
     const {
       error: res_error,
-    } = InventoryModel.ResponseEnvelopeListJobConfigDTO().validate(response, {
+    } = InventoryModel.ResponseEnvelopeEmailJobMetrics().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -425,8 +427,7 @@ class Inventory {
     if (res_error) {
       Logger({
         level: "WARN",
-        message:
-          "Response Validation Warnnings for getJobConfigByIntegrationType",
+        message: "Response Validation Warnnings for saveJobCodesMetrics",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -434,4 +435,5 @@ class Inventory {
     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;
 }