@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

package/sdk/platform/Lead/LeadPlatformClient.js

@@ -2,6 +2,9 @@ const Paginator = require("../../common/Paginator");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const LeadValidator = require("./LeadPlatformValidator");
+const LeadModel = require("./LeadPlatformModel");
+const { Logger } = require("./../../common/Logger");
+
 class Lead {
   constructor(config) {
     this.config = config;
@@ -21,10 +24,11 @@ class Lead {
    *   given set of results.
    * @param {number} [arg.pageSize] - Number of items to retrieve in each
    *   page. Default is 12.
+   * @returns {Promise<TicketList>} - Success response
    * @summary: Gets the list of company level tickets and/or ticket filters depending on query params
    * @description: Gets the list of company level tickets and/or ticket filters
    */
-  getTickets({
+  async getTickets({
     items,
     filters,
     q,
@@ -51,6 +55,28 @@ class Lead {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.getTickets().validate(
+      {
+        items,
+        filters,
+        q,
+        status,
+        priority,
+        category,
+        pageNo,
+        pageSize,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getTickets",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["items"] = items;
     query_params["filters"] = filters;
@@ -63,7 +89,7 @@ class Lead {
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/lead/v1.0/company/${this.config.companyId}/ticket`,
@@ -71,6 +97,21 @@ class Lead {
       undefined,
       xHeaders
     );
+
+    const { error: res_error } = LeadModel.TicketList().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getTickets",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -125,10 +166,11 @@ class Lead {
   /**
    * @param {Object} arg - Arg object.
    * @param {AddTicketPayload} arg.body
+   * @returns {Promise<Ticket>} - Success response
    * @summary: Creates a company level ticket
    * @description: Creates a company level ticket
    */
-  createTicket({ body } = {}) {
+  async createTicket({ body } = {}) {
     const { error } = LeadValidator.createTicket().validate(
       {
         body,
@@ -139,11 +181,26 @@ class Lead {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.createTicket().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for createTicket",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/lead/v1.0/company/${this.config.companyId}/ticket`,
@@ -151,15 +208,31 @@ class Lead {
       body,
       xHeaders
     );
+
+    const { error: res_error } = LeadModel.Ticket().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for createTicket",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.id - Tiket ID of the ticket to be fetched
+   * @returns {Promise<Ticket>} - Success response
    * @summary: Retreives ticket details of a company level ticket with ticket ID
    * @description: Retreives ticket details of a company level ticket
    */
-  getTicket({ id } = {}) {
+  async getTicket({ id } = {}) {
     const { error } = LeadValidator.getTicket().validate(
       {
         id,
@@ -170,11 +243,26 @@ class Lead {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.getTicket().validate(
+      {
+        id,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getTicket",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/lead/v1.0/company/${this.config.companyId}/ticket/${id}`,
@@ -182,16 +270,32 @@ class Lead {
       undefined,
       xHeaders
     );
+
+    const { error: res_error } = LeadModel.Ticket().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getTicket",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.id - Ticket ID of ticket to be edited
    * @param {EditTicketPayload} arg.body
+   * @returns {Promise<Ticket>} - Success response
    * @summary: Edits ticket details of a company level ticket
    * @description: Edits ticket details of a company level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes
    */
-  editTicket({ id, body } = {}) {
+  async editTicket({ id, body } = {}) {
     const { error } = LeadValidator.editTicket().validate(
       {
         id,
@@ -203,11 +307,27 @@ class Lead {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.editTicket().validate(
+      {
+        id,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for editTicket",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "put",
       `/service/platform/lead/v1.0/company/${this.config.companyId}/ticket/${id}`,
@@ -215,16 +335,32 @@ class Lead {
       body,
       xHeaders
     );
+
+    const { error: res_error } = LeadModel.Ticket().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for editTicket",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.id - Ticket ID for which history is created
    * @param {TicketHistoryPayload} arg.body
+   * @returns {Promise<TicketHistory>} - Success response
    * @summary: Create history for specific company level ticket
    * @description: Create history for specific company level ticket, this history is seen on ticket detail page, this can be comment, log or rating.
    */
-  createHistory({ id, body } = {}) {
+  async createHistory({ id, body } = {}) {
     const { error } = LeadValidator.createHistory().validate(
       {
         id,
@@ -236,11 +372,27 @@ class Lead {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.createHistory().validate(
+      {
+        id,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for createHistory",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/lead/v1.0/company/${this.config.companyId}/ticket/${id}/history`,
@@ -248,15 +400,31 @@ class Lead {
       body,
       xHeaders
     );
+
+    const { error: res_error } = LeadModel.TicketHistory().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for createHistory",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.id - Ticket ID for which history is to be fetched
+   * @returns {Promise<TicketHistoryList>} - Success response
    * @summary: Gets history list for specific company level ticket
    * @description: Gets history list for specific company level ticket, this history is seen on ticket detail page, this can be comment, log or rating.
    */
-  getTicketHistory({ id } = {}) {
+  async getTicketHistory({ id } = {}) {
     const { error } = LeadValidator.getTicketHistory().validate(
       {
         id,
@@ -267,11 +435,26 @@ class Lead {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.getTicketHistory().validate(
+      {
+        id,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getTicketHistory",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/lead/v1.0/company/${this.config.companyId}/ticket/${id}/history`,
@@ -279,15 +462,33 @@ class Lead {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = LeadModel.TicketHistoryList().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getTicketHistory",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.id - Ticket ID for which feedbacks are to be fetched
+   * @returns {Promise<TicketFeedbackList>} - Success response
    * @summary: Gets a list of feedback submitted against that ticket
    * @description: Gets a list of feedback submitted against that ticket
    */
-  getFeedbacks({ id } = {}) {
+  async getFeedbacks({ id } = {}) {
     const { error } = LeadValidator.getFeedbacks().validate(
       {
         id,
@@ -298,11 +499,26 @@ class Lead {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.getFeedbacks().validate(
+      {
+        id,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getFeedbacks",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/lead/v1.0/company/${this.config.companyId}/ticket/${id}/feedback`,
@@ -310,16 +526,34 @@ class Lead {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = LeadModel.TicketFeedbackList().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getFeedbacks",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.id - Ticket ID for which feedback is to be submitted
    * @param {TicketFeedbackPayload} arg.body
+   * @returns {Promise<TicketFeedback>} - Success response
    * @summary: Submit a response for feeback form against that ticket
    * @description: Submit a response for feeback form against that ticket
    */
-  submitFeedback({ id, body } = {}) {
+  async submitFeedback({ id, body } = {}) {
     const { error } = LeadValidator.submitFeedback().validate(
       {
         id,
@@ -331,11 +565,27 @@ class Lead {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.submitFeedback().validate(
+      {
+        id,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for submitFeedback",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/lead/v1.0/company/${this.config.companyId}/ticket/${id}/feedback`,
@@ -343,15 +593,31 @@ class Lead {
       body,
       xHeaders
     );
+
+    const { error: res_error } = LeadModel.TicketFeedback().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for submitFeedback",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.uniqueName - Unique name of video room
+   * @returns {Promise<GetTokenForVideoRoomResponse>} - Success response
    * @summary: Get Token to join a specific Video Room using it's unqiue name
    * @description: Get Token to join a specific Video Room using it's unqiue name, this Token is your ticket to Room and also creates your identity there.
    */
-  getTokenForVideoRoom({ uniqueName } = {}) {
+  async getTokenForVideoRoom({ uniqueName } = {}) {
     const { error } = LeadValidator.getTokenForVideoRoom().validate(
       {
         uniqueName,
@@ -362,11 +628,26 @@ class Lead {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.getTokenForVideoRoom().validate(
+      {
+        uniqueName,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getTokenForVideoRoom",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/lead/v1.0/company/${this.config.companyId}/video/room/${uniqueName}/token`,
@@ -374,15 +655,33 @@ class Lead {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = LeadModel.GetTokenForVideoRoomResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getTokenForVideoRoom",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.uniqueName - Unique name of Video Room
+   * @returns {Promise<GetParticipantsInsideVideoRoomResponse>} - Success response
    * @summary: Get participants of a specific Video Room using it's unique name
    * @description: Get participants of a specific Video Room using it's unique name, this can be used to check if people are already there in the room and also to show their names.
    */
-  getVideoParticipants({ uniqueName } = {}) {
+  async getVideoParticipants({ uniqueName } = {}) {
     const { error } = LeadValidator.getVideoParticipants().validate(
       {
         uniqueName,
@@ -393,11 +692,26 @@ class Lead {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.getVideoParticipants().validate(
+      {
+        uniqueName,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getVideoParticipants",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/lead/v1.0/company/${this.config.companyId}/video/room/${uniqueName}/participants`,
@@ -405,14 +719,32 @@ class Lead {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = LeadModel.GetParticipantsInsideVideoRoomResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getVideoParticipants",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
+   * @returns {Promise<CloseVideoRoomResponse>} - Success response
    * @summary: Get general support configuration.
    * @description: Get general support configuration.
    */
-  getGeneralConfig({} = {}) {
+  async getGeneralConfig({} = {}) {
     const { error } = LeadValidator.getGeneralConfig().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -421,11 +753,24 @@ class Lead {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.getGeneralConfig().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getGeneralConfig",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/lead/v1.0/company/${this.config.companyId}/general-config`,
@@ -433,6 +778,23 @@ class Lead {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = LeadModel.CloseVideoRoomResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getGeneralConfig",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 }