@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

package/sdk/platform/Webhook/WebhookPlatformClient.d.ts

@@ -7,6 +7,7 @@ declare class Webhook {
      * @param {number} [arg.pageNo] - Page Number
      * @param {number} [arg.pageSize] - Page Size
      * @param {string} [arg.extensionId] - Extension ID
+     * @returns {Promise<SubscriberResponse>} - Success response
      * @summary: Get Subscribers By Company ID
      * @description: Get Subscribers By CompanyId
      */
@@ -14,30 +15,33 @@ declare class Webhook {
         pageNo?: number;
         pageSize?: number;
         extensionId?: string;
-    }): Promise<any>;
+    }): Promise<SubscriberResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {SubscriberConfig} arg.body
+     * @returns {Promise<SubscriberConfig>} - Success response
      * @summary: Register Subscriber
      * @description: Register Subscriber
      */
     registerSubscriberToEvent({ body }?: {
         body: SubscriberConfig;
-    }): Promise<any>;
+    }): Promise<SubscriberConfig>;
     /**
      * @param {Object} arg - Arg object.
      * @param {SubscriberConfig} arg.body
+     * @returns {Promise<SubscriberConfig>} - Success response
      * @summary: Update Subscriber
      * @description: Update Subscriber
      */
     updateSubscriberConfig({ body }?: {
         body: SubscriberConfig;
-    }): Promise<any>;
+    }): Promise<SubscriberConfig>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] - Page Number
      * @param {number} [arg.pageSize] - Page Size
      * @param {string} arg.extensionId - Extension ID
+     * @returns {Promise<SubscriberConfigList>} - Success response
      * @summary: Get Subscribers By Extension ID
      * @description: Get Subscribers By ExtensionID
      */
@@ -45,20 +49,22 @@ declare class Webhook {
         pageNo?: number;
         pageSize?: number;
         extensionId: string;
-    }): Promise<any>;
+    }): Promise<SubscriberConfigList>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} arg.subscriberId - Subscriber ID
+     * @returns {Promise<SubscriberResponse>} - Success response
      * @summary: Get Subscriber By Subscriber ID
      * @description: Get Subscriber By Subscriber ID
      */
     getSubscriberById({ subscriberId }?: {
         subscriberId: number;
-    }): Promise<any>;
+    }): Promise<SubscriberResponse>;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<EventConfigResponse>} - Success response
      * @summary:
      * @description: Get All Webhook Events
      */
-    fetchAllEventConfigurations({}?: any): Promise<any>;
+    fetchAllEventConfigurations({}?: any): Promise<EventConfigResponse>;
 }

package/sdk/platform/Webhook/WebhookPlatformClient.js

@@ -2,6 +2,9 @@ const Paginator = require("../../common/Paginator");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const WebhookValidator = require("./WebhookPlatformValidator");
+const WebhookModel = require("./WebhookPlatformModel");
+const { Logger } = require("./../../common/Logger");
+
 class Webhook {
   constructor(config) {
     this.config = config;
@@ -12,10 +15,11 @@ class Webhook {
    * @param {number} [arg.pageNo] - Page Number
    * @param {number} [arg.pageSize] - Page Size
    * @param {string} [arg.extensionId] - Extension ID
+   * @returns {Promise<SubscriberResponse>} - Success response
    * @summary: Get Subscribers By Company ID
    * @description: Get Subscribers By CompanyId
    */
-  getSubscribersByCompany({ pageNo, pageSize, extensionId } = {}) {
+  async getSubscribersByCompany({ pageNo, pageSize, extensionId } = {}) {
     const { error } = WebhookValidator.getSubscribersByCompany().validate(
       {
         pageNo,
@@ -28,6 +32,25 @@ class Webhook {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = WebhookValidator.getSubscribersByCompany().validate(
+      {
+        pageNo,
+        pageSize,
+        extensionId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getSubscribersByCompany",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["page_no"] = pageNo;
     query_params["page_size"] = pageSize;
@@ -35,7 +58,7 @@ class Webhook {
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber`,
@@ -43,15 +66,33 @@ class Webhook {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = WebhookModel.SubscriberResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getSubscribersByCompany",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {SubscriberConfig} arg.body
+   * @returns {Promise<SubscriberConfig>} - Success response
    * @summary: Register Subscriber
    * @description: Register Subscriber
    */
-  registerSubscriberToEvent({ body } = {}) {
+  async registerSubscriberToEvent({ body } = {}) {
     const { error } = WebhookValidator.registerSubscriberToEvent().validate(
       {
         body,
@@ -62,11 +103,28 @@ class Webhook {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = WebhookValidator.registerSubscriberToEvent().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for registerSubscriberToEvent",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber`,
@@ -74,15 +132,33 @@ class Webhook {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = WebhookModel.SubscriberConfig().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for registerSubscriberToEvent",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {SubscriberConfig} arg.body
+   * @returns {Promise<SubscriberConfig>} - Success response
    * @summary: Update Subscriber
    * @description: Update Subscriber
    */
-  updateSubscriberConfig({ body } = {}) {
+  async updateSubscriberConfig({ body } = {}) {
     const { error } = WebhookValidator.updateSubscriberConfig().validate(
       {
         body,
@@ -93,11 +169,28 @@ class Webhook {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = WebhookValidator.updateSubscriberConfig().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for updateSubscriberConfig",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "put",
       `/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber`,
@@ -105,6 +198,23 @@ class Webhook {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = WebhookModel.SubscriberConfig().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for updateSubscriberConfig",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -112,10 +222,11 @@ class Webhook {
    * @param {number} [arg.pageNo] - Page Number
    * @param {number} [arg.pageSize] - Page Size
    * @param {string} arg.extensionId - Extension ID
+   * @returns {Promise<SubscriberConfigList>} - Success response
    * @summary: Get Subscribers By Extension ID
    * @description: Get Subscribers By ExtensionID
    */
-  getSubscribersByExtensionId({ extensionId, pageNo, pageSize } = {}) {
+  async getSubscribersByExtensionId({ extensionId, pageNo, pageSize } = {}) {
     const { error } = WebhookValidator.getSubscribersByExtensionId().validate(
       {
         extensionId,
@@ -128,13 +239,33 @@ class Webhook {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = WebhookValidator.getSubscribersByExtensionId().validate(
+      {
+        extensionId,
+        pageNo,
+        pageSize,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message:
+          "Parameter Validation warrnings for getSubscribersByExtensionId",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["page_no"] = pageNo;
     query_params["page_size"] = pageSize;
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/webhook/v1.0/company/${this.config.companyId}/extension/${extensionId}/subscriber`,
@@ -142,15 +273,34 @@ class Webhook {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = WebhookModel.SubscriberConfigList().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message:
+          "Response Validation Warnnings for getSubscribersByExtensionId",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {number} arg.subscriberId - Subscriber ID
+   * @returns {Promise<SubscriberResponse>} - Success response
    * @summary: Get Subscriber By Subscriber ID
    * @description: Get Subscriber By Subscriber ID
    */
-  getSubscriberById({ subscriberId } = {}) {
+  async getSubscriberById({ subscriberId } = {}) {
     const { error } = WebhookValidator.getSubscriberById().validate(
       {
         subscriberId,
@@ -161,11 +311,26 @@ class Webhook {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = WebhookValidator.getSubscriberById().validate(
+      {
+        subscriberId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getSubscriberById",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber/${subscriberId}`,
@@ -173,14 +338,32 @@ class Webhook {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = WebhookModel.SubscriberResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getSubscriberById",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
+   * @returns {Promise<EventConfigResponse>} - Success response
    * @summary:
    * @description: Get All Webhook Events
    */
-  fetchAllEventConfigurations({} = {}) {
+  async fetchAllEventConfigurations({} = {}) {
     const { error } = WebhookValidator.fetchAllEventConfigurations().validate(
       {},
       { abortEarly: false, allowUnknown: true }
@@ -189,11 +372,27 @@ class Webhook {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = WebhookValidator.fetchAllEventConfigurations().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message:
+          "Parameter Validation warrnings for fetchAllEventConfigurations",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/webhook/v1.0/company/${this.config.companyId}/events`,
@@ -201,6 +400,24 @@ class Webhook {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = WebhookModel.EventConfigResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message:
+          "Response Validation Warnnings for fetchAllEventConfigurations",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 }
 

package/sdk/public/Configuration/ConfigurationPublicClient.js

@@ -1,7 +1,11 @@
 const PublicAPIClient = require("../PublicAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const constructUrl = require("../constructUrl");
+const Paginator = require("../../common/Paginator");
 const ConfigurationValidator = require("./ConfigurationPublicValidator");
+const ConfigurationModel = require("./ConfigurationPublicModel");
+const { Logger } = require("./../../common/Logger");
+
 class Configuration {
   constructor(_conf) {
     this._conf = _conf;
@@ -34,7 +38,7 @@ class Configuration {
    * @summary: Search Application
    * @description: Provide application name or domain url
    */
-  searchApplication({ authorization, query } = {}) {
+  async searchApplication({ authorization, query } = {}) {
     const { error } = ConfigurationValidator.searchApplication().validate(
       { authorization, query },
       { abortEarly: false, allowUnknown: true }
@@ -42,13 +46,29 @@ class Configuration {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = ConfigurationValidator.searchApplication().validate(
+      { authorization, query },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for searchApplication",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["query"] = query;
 
     const xHeaders = {};
     xHeaders["authorization"] = authorization;
 
-    return PublicAPIClient.execute(
+    const response = await PublicAPIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -59,6 +79,23 @@ class Configuration {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = ConfigurationModel.ApplicationResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for searchApplication",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -72,7 +109,7 @@ class Configuration {
    * @summary: Get countries, states, cities
    * @description:
    */
-  getLocations({ locationType, id } = {}) {
+  async getLocations({ locationType, id } = {}) {
     const { error } = ConfigurationValidator.getLocations().validate(
       { locationType, id },
       { abortEarly: false, allowUnknown: true }
@@ -80,13 +117,27 @@ class Configuration {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = ConfigurationValidator.getLocations().validate(
+      { locationType, id },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getLocations",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["location_type"] = locationType;
     query_params["id"] = id;
 
     const xHeaders = {};
 
-    return PublicAPIClient.execute(
+    const response = await PublicAPIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -97,6 +148,23 @@ class Configuration {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = ConfigurationModel.Locations().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getLocations",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 }
 module.exports = Configuration;

package/sdk/public/Configuration/ConfigurationPublicValidator.js

@@ -1,5 +1,6 @@
-const ConfigurationModel = require("./ConfigurationPublicModel");
 const Joi = require("joi");
+
+const ConfigurationModel = require("./ConfigurationPublicModel");
 class ConfigurationValidator {
   static searchApplication() {
     return Joi.object({
@@ -15,4 +16,5 @@ class ConfigurationValidator {
     });
   }
 }
+
 module.exports = ConfigurationValidator;