@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

package/sdk/application/Content/ContentApplicationModel.d.ts

@@ -3,6 +3,7 @@ declare class ContentModel {
     static ApplicationLegal(): any;
     static ApplicationLegalFAQ(): any;
     static PathMappingSchema(): any;
+    static PathSourceSchema(): any;
     static SeoComponent(): any;
     static SeoSchema(): any;
     static CustomMetaTag(): any;

package/sdk/application/Content/ContentApplicationModel.js

@@ -45,7 +45,15 @@ class ContentModel {
 
       created_at: Joi.string().allow(""),
 
-      __source: ContentModel.TagSourceSchema(),
+      __source: ContentModel.PathSourceSchema(),
+    });
+  }
+
+  static PathSourceSchema() {
+    return Joi.object({
+      type: Joi.string().allow(""),
+
+      id: Joi.string().allow(""),
     });
   }
 
@@ -65,6 +73,8 @@ class ContentModel {
 
       sitemap_enabled: Joi.boolean(),
 
+      cannonical_enabled: Joi.boolean(),
+
       custom_meta_tags: Joi.array().items(Joi.any()),
 
       details: ContentModel.Detail(),

package/sdk/application/Content/ContentApplicationValidator.js

@@ -104,4 +104,5 @@ class ContentValidator {
     });
   }
 }
+
 module.exports = ContentValidator;

package/sdk/application/FileStorage/FileStorageApplicationClient.js

@@ -3,6 +3,8 @@ const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const FileStorageValidator = require("./FileStorageApplicationValidator");
+const FileStorageModel = require("./FileStorageApplicationModel");
+const { Logger } = require("./../../common/Logger");
 const axios = require("axios");
 
 class FileStorage {
@@ -56,7 +58,7 @@ class FileStorage {
    * After successfully upload, call the `completeUpload` API to finish the upload process.
    * This operation will return the URL of the uploaded file.
    */
-  startUpload({ namespace, body } = {}) {
+  async startUpload({ namespace, body } = {}) {
     const { error } = FileStorageValidator.startUpload().validate(
       { namespace, body },
       { abortEarly: false, allowUnknown: true }
@@ -64,11 +66,25 @@ class FileStorage {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = FileStorageValidator.startUpload().validate(
+      { namespace, body },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for startUpload",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "post",
       constructUrl({
@@ -79,6 +95,23 @@ class FileStorage {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = FileStorageModel.StartResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for startUpload",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -106,7 +139,7 @@ class FileStorage {
    * After successfully upload, call the `completeUpload` API to finish the upload process.
    * This operation will return the URL of the uploaded file.
    */
-  completeUpload({ namespace, body } = {}) {
+  async completeUpload({ namespace, body } = {}) {
     const { error } = FileStorageValidator.completeUpload().validate(
       { namespace, body },
       { abortEarly: false, allowUnknown: true }
@@ -114,11 +147,25 @@ class FileStorage {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = FileStorageValidator.completeUpload().validate(
+      { namespace, body },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for completeUpload",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "post",
       constructUrl({
@@ -129,6 +176,23 @@ class FileStorage {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = FileStorageModel.CompleteResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for completeUpload",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -138,7 +202,7 @@ class FileStorage {
    * @summary: Explain here
    * @description: Describe here
    */
-  signUrls({ body } = {}) {
+  async signUrls({ body } = {}) {
     const { error } = FileStorageValidator.signUrls().validate(
       { body },
       { abortEarly: false, allowUnknown: true }
@@ -146,11 +210,25 @@ class FileStorage {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = FileStorageValidator.signUrls().validate(
+      { body },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for signUrls",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "post",
       constructUrl({
@@ -161,6 +239,23 @@ class FileStorage {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = FileStorageModel.SignUrlResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for signUrls",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 }
 

package/sdk/application/FileStorage/FileStorageApplicationValidator.js

@@ -22,4 +22,5 @@ class FileStorageValidator {
     }).required();
   }
 }
+
 module.exports = FileStorageValidator;

package/sdk/application/Lead/LeadApplicationClient.js

@@ -3,6 +3,8 @@ 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) {
@@ -41,7 +43,7 @@ class Lead {
    * @summary: Get Ticket with the specific id
    * @description: Get Ticket with the specific id, this is used to view the ticket details
    */
-  getTicket({ id } = {}) {
+  async getTicket({ id } = {}) {
     const { error } = LeadValidator.getTicket().validate(
       { id },
       { abortEarly: false, allowUnknown: true }
@@ -49,11 +51,25 @@ class Lead {
     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) {
+      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({
@@ -64,6 +80,21 @@ 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;
   }
 
   /**
@@ -74,7 +105,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 }
@@ -82,11 +113,25 @@ class Lead {
     if (error) {
       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 APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "post",
       constructUrl({
@@ -97,6 +142,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;
   }
 
   /**
@@ -106,7 +166,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 }
@@ -114,11 +174,25 @@ class Lead {
     if (error) {
       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 APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "post",
       constructUrl({
@@ -129,6 +203,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;
   }
 
   /**
@@ -138,7 +227,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 }
@@ -146,11 +235,25 @@ class Lead {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = LeadValidator.getCustomForm().validate(
+      { slug },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (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({
@@ -161,6 +264,21 @@ 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;
   }
 
   /**
@@ -171,7 +289,7 @@ class Lead {
    * @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.
    */
-  submitCustomForm({ slug, body } = {}) {
+  async submitCustomForm({ slug, body } = {}) {
     const { error } = LeadValidator.submitCustomForm().validate(
       { slug, body },
       { abortEarly: false, allowUnknown: true }
@@ -179,11 +297,25 @@ class Lead {
     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 = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "post",
       constructUrl({
@@ -194,6 +326,23 @@ class Lead {
       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;
   }
 
   /**
@@ -203,7 +352,7 @@ class Lead {
    * @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.
    */
-  getParticipantsInsideVideoRoom({ uniqueName } = {}) {
+  async getParticipantsInsideVideoRoom({ uniqueName } = {}) {
     const { error } = LeadValidator.getParticipantsInsideVideoRoom().validate(
       { uniqueName },
       { abortEarly: false, allowUnknown: true }
@@ -211,11 +360,28 @@ class Lead {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = LeadValidator.getParticipantsInsideVideoRoom().validate(
+      { uniqueName },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (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,
       "get",
       constructUrl({
@@ -226,6 +392,24 @@ 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 getParticipantsInsideVideoRoom",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -235,7 +419,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 }
@@ -243,11 +427,25 @@ class Lead {
     if (error) {
       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 APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -258,6 +456,23 @@ 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;
   }
 }
 

package/sdk/application/Lead/LeadApplicationValidator.js

@@ -46,4 +46,5 @@ class LeadValidator {
     }).required();
   }
 }
+
 module.exports = LeadValidator;