@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

package/sdk/application/Lead/LeadApplicationClient.js

@@ -3,20 +3,22 @@ const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const LeadValidator = require("./LeadApplicationValidator");
+const LeadModel = require("./LeadApplicationModel");
+const { Logger } = require("./../../common/Logger");
 
 class Lead {
   constructor(_conf) {
     this._conf = _conf;
     this._relativeUrls = {
-      getTicket: "/service/application/lead/v1.0/ticket/{id}",
       createHistory: "/service/application/lead/v1.0/ticket/{id}/history",
       createTicket: "/service/application/lead/v1.0/ticket/",
       getCustomForm: "/service/application/lead/v1.0/form/{slug}",
-      submitCustomForm: "/service/application/lead/v1.0/form/{slug}/submit",
       getParticipantsInsideVideoRoom:
         "/service/application/lead/v1.0/video/room/{unique_name}/participants",
+      getTicket: "/service/application/lead/v1.0/ticket/{id}",
       getTokenForVideoRoom:
         "/service/application/lead/v1.0/video/room/{unique_name}/token",
+      submitCustomForm: "/service/application/lead/v1.0/form/{slug}/submit",
     };
     this._urls = Object.entries(this._relativeUrls).reduce(
       (urls, [method, relativeUrl]) => {
@@ -34,49 +36,6 @@ class Lead {
     };
   }
 
-  /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.id - ID of ticket to be retrieved
-   * @returns {Promise<Ticket>} - Success response
-   * @summary: Get Ticket with the specific id
-   * @description: Get Ticket with the specific id, this is used to view the ticket details
-   */
-  getTicket({ id } = {}) {
-    const { error } = LeadValidator.getTicket().validate(
-      { id },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      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) {
-      console.log("Parameter Validation warrnings for getTicket");
-      console.log(warrning);
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    return APIClient.execute(
-      this._conf,
-      "get",
-      constructUrl({
-        url: this._urls["getTicket"],
-        params: { id },
-      }),
-      query_params,
-      undefined,
-      xHeaders
-    );
-  }
-
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.id - Ticket ID for which history is created
@@ -85,7 +44,7 @@ class Lead {
    * @summary: Create history for specific Ticket
    * @description: Create history for specific 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, body },
       { abortEarly: false, allowUnknown: true }
@@ -100,15 +59,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 APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "post",
       constructUrl({
@@ -119,6 +81,21 @@ 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;
   }
 
   /**
@@ -128,7 +105,7 @@ class Lead {
    * @summary: Create Ticket
    * @description: This is used to Create Ticket.
    */
-  createTicket({ body } = {}) {
+  async createTicket({ body } = {}) {
     const { error } = LeadValidator.createTicket().validate(
       { body },
       { abortEarly: false, allowUnknown: true }
@@ -143,15 +120,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 APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "post",
       constructUrl({
@@ -162,6 +142,21 @@ 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;
   }
 
   /**
@@ -171,7 +166,7 @@ class Lead {
    * @summary: Get specific Custom Form using it's slug
    * @description: Get specific Custom Form using it's slug, this is used to view the form.
    */
-  getCustomForm({ slug } = {}) {
+  async getCustomForm({ slug } = {}) {
     const { error } = LeadValidator.getCustomForm().validate(
       { slug },
       { abortEarly: false, allowUnknown: true }
@@ -186,15 +181,18 @@ class Lead {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getCustomForm");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getCustomForm",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -205,19 +203,33 @@ class Lead {
       undefined,
       xHeaders
     );
+
+    const { error: res_error } = LeadModel.CustomForm().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getCustomForm",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.slug - Slug of form whose response is getting submitted
-   * @param {CustomFormSubmissionPayload} arg.body
-   * @returns {Promise<SubmitCustomFormResponse>} - Success response
-   * @summary: Submit Response for a specific Custom Form using it's slug
-   * @description: Submit Response for a specific Custom Form using it's slug, this response is then used to create a ticket on behalf of the user.
+   * @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.
    */
-  submitCustomForm({ slug, body } = {}) {
-    const { error } = LeadValidator.submitCustomForm().validate(
-      { slug, body },
+  async getParticipantsInsideVideoRoom({ uniqueName } = {}) {
+    const { error } = LeadValidator.getParticipantsInsideVideoRoom().validate(
+      { uniqueName },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -225,42 +237,66 @@ class Lead {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = LeadValidator.submitCustomForm().validate(
-      { slug, body },
+    const {
+      error: warrning,
+    } = LeadValidator.getParticipantsInsideVideoRoom().validate(
+      { uniqueName },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for submitCustomForm");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message:
+          "Parameter Validation warrnings for getParticipantsInsideVideoRoom",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
-      "post",
+      "get",
       constructUrl({
-        url: this._urls["submitCustomForm"],
-        params: { slug },
+        url: this._urls["getParticipantsInsideVideoRoom"],
+        params: { uniqueName },
       }),
       query_params,
-      body,
+      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 getParticipantsInsideVideoRoom",
+      });
+      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.
+   * @param {string} arg.id - ID of ticket to be retrieved
+   * @returns {Promise<Ticket>} - Success response
+   * @summary: Get Ticket with the specific id
+   * @description: Get Ticket with the specific id, this is used to view the ticket details
    */
-  getParticipantsInsideVideoRoom({ uniqueName } = {}) {
-    const { error } = LeadValidator.getParticipantsInsideVideoRoom().validate(
-      { uniqueName },
+  async getTicket({ id } = {}) {
+    const { error } = LeadValidator.getTicket().validate(
+      { id },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -268,34 +304,48 @@ class Lead {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = LeadValidator.getParticipantsInsideVideoRoom().validate(
-      { uniqueName },
+    const { error: warrning } = LeadValidator.getTicket().validate(
+      { id },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log(
-        "Parameter Validation warrnings for getParticipantsInsideVideoRoom"
-      );
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getTicket",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "get",
       constructUrl({
-        url: this._urls["getParticipantsInsideVideoRoom"],
-        params: { uniqueName },
+        url: this._urls["getTicket"],
+        params: { id },
       }),
       query_params,
       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;
   }
 
   /**
@@ -305,7 +355,7 @@ class Lead {
    * @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 },
       { abortEarly: false, allowUnknown: true }
@@ -320,15 +370,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 APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -339,6 +392,87 @@ 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.slug - Slug of form whose response is getting submitted
+   * @param {CustomFormSubmissionPayload} arg.body
+   * @returns {Promise<SubmitCustomFormResponse>} - Success response
+   * @summary: Submit Response for a specific Custom Form using it's slug
+   * @description: Submit Response for a specific Custom Form using it's slug, this response is then used to create a ticket on behalf of the user.
+   */
+  async submitCustomForm({ slug, body } = {}) {
+    const { error } = LeadValidator.submitCustomForm().validate(
+      { slug, body },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.submitCustomForm().validate(
+      { slug, body },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for submitCustomForm",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await APIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["submitCustomForm"],
+        params: { slug },
+      }),
+      query_params,
+      body,
+      xHeaders
+    );
+
+    const {
+      error: res_error,
+    } = LeadModel.SubmitCustomFormResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for submitCustomForm",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 }
 

package/sdk/application/Lead/LeadApplicationModel.d.ts

@@ -1,55 +1,55 @@
 export = LeadModel;
 declare class LeadModel {
-    static TicketList(): any;
-    static Page(): any;
-    static TicketHistoryList(): any;
-    static CustomFormList(): any;
-    static CreateCustomFormPayload(): any;
-    static EditCustomFormPayload(): any;
-    static EditTicketPayload(): any;
+    static AddTicketPayload(): any;
     static AgentChangePayload(): any;
-    static CreateVideoRoomResponse(): any;
+    static CategoryData(): any;
     static CloseVideoRoomResponse(): any;
+    static CommunicationDetails(): any;
+    static CreateCustomFormPayload(): any;
+    static CreatedOn(): any;
     static CreateVideoRoomPayload(): any;
-    static NotifyUser(): any;
-    static Filter(): any;
-    static TicketHistoryPayload(): any;
+    static CreateVideoRoomResponse(): any;
+    static CustomForm(): any;
+    static CustomFormList(): any;
     static CustomFormSubmissionPayload(): any;
-    static GetTokenForVideoRoomResponse(): any;
+    static Debug(): any;
+    static EditCustomFormPayload(): any;
+    static EditTicketPayload(): any;
+    static Email(): any;
+    static FeedbackForm(): any;
+    static FeedbackResponseItem(): any;
+    static Filter(): any;
     static GetParticipantsInsideVideoRoomResponse(): any;
+    static GetTokenForVideoRoomResponse(): any;
+    static IntegrationConfig(): any;
+    static NotifyUser(): any;
+    static Page(): any;
     static Participant(): any;
-    static UserSchema(): any;
     static PhoneNumber(): any;
-    static Email(): any;
-    static Debug(): any;
-    static SubmitCustomFormResponse(): any;
-    static TicketContext(): any;
-    static CreatedOn(): any;
-    static TicketAsset(): any;
-    static TicketContent(): any;
-    static AddTicketPayload(): any;
+    static PollForAssignment(): any;
     static Priority(): any;
     static Status(): any;
-    static TicketFeedbackForm(): any;
-    static TicketFeedbackList(): any;
-    static TicketFeedbackPayload(): any;
     static SubmitButton(): any;
-    static PollForAssignment(): any;
-    static CustomForm(): any;
-    static CommunicationDetails(): any;
+    static SubmitCustomFormResponse(): any;
     static SupportGeneralConfig(): any;
-    static FeedbackForm(): any;
-    static TicketSubCategory(): any;
+    static Ticket(): any;
+    static TicketAsset(): any;
     static TicketCategory(): any;
-    static CategoryData(): any;
-    static IntegrationConfig(): any;
-    static FeedbackResponseItem(): any;
+    static TicketContent(): any;
+    static TicketContext(): any;
     static TicketFeedback(): any;
+    static TicketFeedbackForm(): any;
+    static TicketFeedbackList(): any;
+    static TicketFeedbackPayload(): any;
     static TicketHistory(): any;
-    static Ticket(): any;
-    static PriorityEnum(): any;
+    static TicketHistoryList(): any;
+    static TicketHistoryPayload(): any;
+    static TicketList(): any;
+    static TicketSubCategory(): any;
+    static UserSchema(): any;
     static HistoryTypeEnum(): any;
+    static PriorityEnum(): any;
     static TicketAssetTypeEnum(): any;
-    static TicketSourceEnum(): any;
     static TicketIntegrationDetails(): any;
+    static TicketSourceEnum(): any;
 }