@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/application/Lead/LeadApplicationClient.js

@@ -2,8 +2,8 @@ const ApplicationAPIClient = require("../ApplicationAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
-const LeadValidator = require("./LeadApplicationValidator");
-const LeadModel = require("./LeadApplicationModel");
+const LeadApplicationValidator = require("./LeadApplicationValidator");
+const LeadApplicationModel = require("./LeadApplicationModel");
 const { Logger } = require("./../../common/Logger");
 const Joi = require("joi");
 
@@ -38,15 +38,15 @@ class Lead {
   }
 
   /**
-   * @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
+   * @param {LeadApplicationValidator.CreateHistoryParam} arg - Arg object.
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<LeadApplicationModel.TicketHistory>} - Success response
+   * @name createHistory
    * @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.
+   * @description: Create history for specific Ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createHistory/).
    */
-  async createHistory({ id, body } = {}) {
-    const { error } = LeadValidator.createHistory().validate(
+  async createHistory({ id, body } = {}, { headers } = { headers: false }) {
+    const { error } = LeadApplicationValidator.createHistory().validate(
       { id, body },
       { abortEarly: false, allowUnknown: true }
     );
@@ -55,16 +55,17 @@ class Lead {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = LeadValidator.createHistory().validate(
+    const {
+      error: warrning,
+    } = LeadApplicationValidator.createHistory().validate(
       { id, body },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for createHistory",
+        message: `Parameter Validation warrnings for application > Lead > createHistory \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -80,10 +81,18 @@ class Lead {
       }),
       query_params,
       body,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
-    const { error: res_error } = LeadModel.TicketHistory().validate(response, {
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = LeadApplicationModel.TicketHistory().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -91,23 +100,23 @@ class Lead {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for createHistory",
+        message: `Response Validation Warnnings for application > Lead > createHistory \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {AddTicketPayload} arg.body
-   * @returns {Promise<Ticket>} - Success response
+   * @param {LeadApplicationValidator.CreateTicketParam} arg - Arg object.
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<LeadApplicationModel.Ticket>} - Success response
+   * @name createTicket
    * @summary: Create Ticket
-   * @description: This is used to Create Ticket.
+   * @description: This is used to Create Ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createTicket/).
    */
-  async createTicket({ body } = {}) {
-    const { error } = LeadValidator.createTicket().validate(
+  async createTicket({ body } = {}, { headers } = { headers: false }) {
+    const { error } = LeadApplicationValidator.createTicket().validate(
       { body },
       { abortEarly: false, allowUnknown: true }
     );
@@ -116,16 +125,17 @@ class Lead {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = LeadValidator.createTicket().validate(
+    const {
+      error: warrning,
+    } = LeadApplicationValidator.createTicket().validate(
       { body },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for createTicket",
+        message: `Parameter Validation warrnings for application > Lead > createTicket \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -141,10 +151,18 @@ class Lead {
       }),
       query_params,
       body,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
-    const { error: res_error } = LeadModel.Ticket().validate(response, {
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = LeadApplicationModel.Ticket().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -152,23 +170,23 @@ class Lead {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for createTicket",
+        message: `Response Validation Warnnings for application > Lead > createTicket \n ${res_error}`,
       });
-      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
-   * @returns {Promise<CustomForm>} - Success response
+   * @param {LeadApplicationValidator.GetCustomFormParam} arg - Arg object.
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<LeadApplicationModel.CustomForm>} - Success response
+   * @name getCustomForm
    * @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.
+   * @description: Get specific Custom Form using it's slug, this is used to view the form. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getCustomForm/).
    */
-  async getCustomForm({ slug } = {}) {
-    const { error } = LeadValidator.getCustomForm().validate(
+  async getCustomForm({ slug } = {}, { headers } = { headers: false }) {
+    const { error } = LeadApplicationValidator.getCustomForm().validate(
       { slug },
       { abortEarly: false, allowUnknown: true }
     );
@@ -177,16 +195,17 @@ class Lead {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = LeadValidator.getCustomForm().validate(
+    const {
+      error: warrning,
+    } = LeadApplicationValidator.getCustomForm().validate(
       { slug },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getCustomForm",
+        message: `Parameter Validation warrnings for application > Lead > getCustomForm \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -202,10 +221,18 @@ class Lead {
       }),
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
-    const { error: res_error } = LeadModel.CustomForm().validate(response, {
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = LeadApplicationModel.CustomForm().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -213,23 +240,32 @@ class Lead {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getCustomForm",
+        message: `Response Validation Warnnings for application > Lead > getCustomForm \n ${res_error}`,
       });
-      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
+   * @param {LeadApplicationValidator.GetParticipantsInsideVideoRoomParam} arg
+   *   - Arg object.
+   *
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<LeadApplicationModel.GetParticipantsInsideVideoRoomResponse>}
+   *   - Success response
+   *
+   * @name getParticipantsInsideVideoRoom
    * @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.
+   * @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. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getParticipantsInsideVideoRoom/).
    */
-  async getParticipantsInsideVideoRoom({ uniqueName } = {}) {
-    const { error } = LeadValidator.getParticipantsInsideVideoRoom().validate(
+  async getParticipantsInsideVideoRoom(
+    { uniqueName } = {},
+    { headers } = { headers: false }
+  ) {
+    const {
+      error,
+    } = LeadApplicationValidator.getParticipantsInsideVideoRoom().validate(
       { uniqueName },
       { abortEarly: false, allowUnknown: true }
     );
@@ -240,17 +276,15 @@ class Lead {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = LeadValidator.getParticipantsInsideVideoRoom().validate(
+    } = LeadApplicationValidator.getParticipantsInsideVideoRoom().validate(
       { uniqueName },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message:
-          "Parameter Validation warrnings for getParticipantsInsideVideoRoom",
+        message: `Parameter Validation warrnings for application > Lead > getParticipantsInsideVideoRoom \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -266,37 +300,42 @@ class Lead {
       }),
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = LeadModel.GetParticipantsInsideVideoRoomResponse().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = LeadApplicationModel.GetParticipantsInsideVideoRoomResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message:
-          "Response Validation Warnnings for getParticipantsInsideVideoRoom",
+        message: `Response Validation Warnnings for application > Lead > getParticipantsInsideVideoRoom \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.id - ID of ticket to be retrieved
-   * @returns {Promise<Ticket>} - Success response
+   * @param {LeadApplicationValidator.GetTicketParam} arg - Arg object.
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<LeadApplicationModel.Ticket>} - Success response
+   * @name getTicket
    * @summary: Get Ticket with the specific id
-   * @description: Get Ticket with the specific id, this is used to view the ticket details
+   * @description: Get Ticket with the specific id, this is used to view the ticket details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getTicket/).
    */
-  async getTicket({ id } = {}) {
-    const { error } = LeadValidator.getTicket().validate(
+  async getTicket({ id } = {}, { headers } = { headers: false }) {
+    const { error } = LeadApplicationValidator.getTicket().validate(
       { id },
       { abortEarly: false, allowUnknown: true }
     );
@@ -305,16 +344,15 @@ class Lead {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = LeadValidator.getTicket().validate(
+    const { error: warrning } = LeadApplicationValidator.getTicket().validate(
       { id },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getTicket",
+        message: `Parameter Validation warrnings for application > Lead > getTicket \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -330,10 +368,18 @@ class Lead {
       }),
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
-    const { error: res_error } = LeadModel.Ticket().validate(response, {
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = LeadApplicationModel.Ticket().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -341,23 +387,27 @@ class Lead {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getTicket",
+        message: `Response Validation Warnnings for application > Lead > getTicket \n ${res_error}`,
       });
-      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
+   * @param {LeadApplicationValidator.GetTokenForVideoRoomParam} arg - Arg object.
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<LeadApplicationModel.GetTokenForVideoRoomResponse>} -
+   *   Success response
+   * @name getTokenForVideoRoom
    * @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.
+   * @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. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getTokenForVideoRoom/).
    */
-  async getTokenForVideoRoom({ uniqueName } = {}) {
-    const { error } = LeadValidator.getTokenForVideoRoom().validate(
+  async getTokenForVideoRoom(
+    { uniqueName } = {},
+    { headers } = { headers: false }
+  ) {
+    const { error } = LeadApplicationValidator.getTokenForVideoRoom().validate(
       { uniqueName },
       { abortEarly: false, allowUnknown: true }
     );
@@ -366,16 +416,17 @@ class Lead {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = LeadValidator.getTokenForVideoRoom().validate(
+    const {
+      error: warrning,
+    } = LeadApplicationValidator.getTokenForVideoRoom().validate(
       { uniqueName },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getTokenForVideoRoom",
+        message: `Parameter Validation warrnings for application > Lead > getTokenForVideoRoom \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -391,37 +442,46 @@ class Lead {
       }),
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = LeadModel.GetTokenForVideoRoomResponse().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = LeadApplicationModel.GetTokenForVideoRoomResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getTokenForVideoRoom",
+        message: `Response Validation Warnnings for application > Lead > getTokenForVideoRoom \n ${res_error}`,
       });
-      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
+   * @param {LeadApplicationValidator.SubmitCustomFormParam} arg - Arg object.
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<LeadApplicationModel.SubmitCustomFormResponse>} -
+   *   Success response
+   * @name submitCustomForm
    * @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.
+   * @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. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/submitCustomForm/).
    */
-  async submitCustomForm({ slug, body } = {}) {
-    const { error } = LeadValidator.submitCustomForm().validate(
+  async submitCustomForm(
+    { slug, body } = {},
+    { headers } = { headers: false }
+  ) {
+    const { error } = LeadApplicationValidator.submitCustomForm().validate(
       { slug, body },
       { abortEarly: false, allowUnknown: true }
     );
@@ -430,16 +490,17 @@ class Lead {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = LeadValidator.submitCustomForm().validate(
+    const {
+      error: warrning,
+    } = LeadApplicationValidator.submitCustomForm().validate(
       { slug, body },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for submitCustomForm",
+        message: `Parameter Validation warrnings for application > Lead > submitCustomForm \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -455,12 +516,18 @@ class Lead {
       }),
       query_params,
       body,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = LeadModel.SubmitCustomFormResponse().validate(response, {
+    } = LeadApplicationModel.SubmitCustomFormResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -468,9 +535,8 @@ class Lead {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for submitCustomForm",
+        message: `Response Validation Warnnings for application > Lead > submitCustomForm \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;