@gofynd/fdk-client-javascript 1.0.1 → 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,
@@ -66,8 +70,11 @@ class Lead {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getTickets");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getTickets",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -82,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`,
@@ -90,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;
   }
 
   /**
@@ -144,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,
@@ -166,15 +189,18 @@ class Lead {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for createTicket");
-      console.log(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`,
@@ -182,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,
@@ -209,15 +251,18 @@ class Lead {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getTicket");
-      console.log(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}`,
@@ -225,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,
@@ -255,15 +316,18 @@ class Lead {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for editTicket");
-      console.log(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}`,
@@ -271,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,
@@ -301,15 +381,18 @@ class Lead {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for createHistory");
-      console.log(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`,
@@ -317,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,
@@ -344,15 +443,18 @@ class Lead {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getTicketHistory");
-      console.log(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`,
@@ -360,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,
@@ -387,15 +507,18 @@ class Lead {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getFeedbacks");
-      console.log(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`,
@@ -403,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,
@@ -433,15 +574,18 @@ class Lead {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for submitFeedback");
-      console.log(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`,
@@ -449,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,
@@ -476,15 +636,18 @@ class Lead {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getTokenForVideoRoom");
-      console.log(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`,
@@ -492,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,
@@ -519,15 +700,18 @@ class Lead {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getVideoParticipants");
-      console.log(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`,
@@ -535,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 }
@@ -557,15 +759,18 @@ class Lead {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getGeneralConfig");
-      console.log(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`,
@@ -573,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;
   }
 }
 

package/sdk/platform/OAuthClient.js

@@ -49,11 +49,11 @@ class OAuthClient {
     if (this.refreshToken && this.useAutoRenewTimer) {
       this.retryOAuthToken(token.expires_in);
     }
-    Logger({ type: "INFO", message: "Token set." });
+    Logger({ level: "INFO", message: "Token set." });
   }
 
   retryOAuthToken(expires_in) {
-    Logger({ type: "INFO", message: "Retrying OAuth Token..." });
+    Logger({ level: "INFO", message: "Retrying OAuth Token..." });
     if (this.retryOAuthTokenTimer) {
       clearTimeout(this.retryOAuthTokenTimer);
     }
@@ -65,7 +65,7 @@ class OAuthClient {
   }
 
   startAuthorization(options) {
-    Logger({ type: "INFO", message: "Starting Authorization..." });
+    Logger({ level: "INFO", message: "Starting Authorization..." });
     let query = {
       client_id: this.config.apiKey,
       scope: options.scope.join(","),
@@ -86,7 +86,7 @@ class OAuthClient {
       signQuery: true,
     };
     signingOptions = sign(signingOptions);
-    Logger({ type: "INFO", message: "Authorization successful.!" });
+    Logger({ level: "INFO", message: "Authorization successful.!" });
 
     return `${this.config.domain}${signingOptions.path}`;
   }
@@ -116,7 +116,7 @@ class OAuthClient {
 
   async renewAccessToken(isOfflineToken = false) {
     try {
-      Logger({ type: "INFO", message: "Renewing Access token..." });
+      Logger({ level: "INFO", message: "Renewing Access token..." });
       let res;
       if (isOfflineToken) {
         let requestCacheKey = `${this.config.apiKey}:${this.config.companyId}`;
@@ -138,7 +138,7 @@ class OAuthClient {
       this.setToken(res);
       this.token_expires_at =
         new Date().getTime() + this.token_expires_in * 1000;
-      Logger({ type: "INFO", message: "Done." });
+      Logger({ level: "INFO", message: "Done." });
       return res;
     } catch (error) {
       if (error.isAxiosError) {
@@ -149,7 +149,7 @@ class OAuthClient {
   }
 
   async getAccesstokenObj({ grant_type, refresh_token, code }) {
-    Logger({ type: "INFO", message: "Processing Access token object..." });
+    Logger({ level: "INFO", message: "Processing Access token object..." });
     let reqData = {
       grant_type: grant_type,
     };
@@ -173,7 +173,7 @@ class OAuthClient {
         "Content-Type": "application/x-www-form-urlencoded",
       },
     };
-    Logger({ type: "INFO", message: "Done." });
+    Logger({ level: "INFO", message: "Done." });
     return fdkAxios.request(rawRequest);
   }