@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/platform/Webhook/WebhookPlatformValidator.js

@@ -1,17 +1,52 @@
 const Joi = require("joi");
 
-const WebhookModel = require("./WebhookPlatformModel");
-class WebhookValidator {
+const WebhookPlatformModel = require("./WebhookPlatformModel");
+
+/** @typedef FetchAllEventConfigurationsParam */
+
+/**
+ * @typedef GetSubscriberByIdParam
+ * @property {number} subscriberId - Subscriber ID
+ */
+
+/**
+ * @typedef GetSubscribersByCompanyParam
+ * @property {number} [pageNo] - Page Number
+ * @property {number} [pageSize] - Page Size
+ * @property {string} [extensionId] - Extension ID
+ */
+
+/**
+ * @typedef GetSubscribersByExtensionIdParam
+ * @property {number} [pageNo] - Page Number
+ * @property {number} [pageSize] - Page Size
+ * @property {string} extensionId - Extension ID
+ */
+
+/**
+ * @typedef RegisterSubscriberToEventParam
+ * @property {WebhookPlatformModel.SubscriberConfig} body
+ */
+
+/**
+ * @typedef UpdateSubscriberConfigParam
+ * @property {WebhookPlatformModel.SubscriberConfig} body
+ */
+
+class WebhookPlatformValidator {
+  /** @returns {FetchAllEventConfigurationsParam} */
   static fetchAllEventConfigurations() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetSubscriberByIdParam} */
   static getSubscriberById() {
     return Joi.object({
       subscriberId: Joi.number().required(),
     }).required();
   }
 
+  /** @returns {GetSubscribersByCompanyParam} */
   static getSubscribersByCompany() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -20,6 +55,7 @@ class WebhookValidator {
     }).required();
   }
 
+  /** @returns {GetSubscribersByExtensionIdParam} */
   static getSubscribersByExtensionId() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -28,17 +64,19 @@ class WebhookValidator {
     }).required();
   }
 
+  /** @returns {RegisterSubscriberToEventParam} */
   static registerSubscriberToEvent() {
     return Joi.object({
-      body: WebhookModel.SubscriberConfig().required(),
+      body: WebhookPlatformModel.SubscriberConfig().required(),
     }).required();
   }
 
+  /** @returns {UpdateSubscriberConfigParam} */
   static updateSubscriberConfig() {
     return Joi.object({
-      body: WebhookModel.SubscriberConfig().required(),
+      body: WebhookPlatformModel.SubscriberConfig().required(),
     }).required();
   }
 }
 
-module.exports = WebhookValidator;
+module.exports = WebhookPlatformValidator;

package/sdk/public/Configuration/ConfigurationPublicClient.d.ts

@@ -9,30 +9,23 @@ declare class Configuration {
     _urls: {};
     updateUrls(urls: any): void;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} [arg.locationType] - Provide location type to query on.
-     *   Possible values : country, state, city
-     * @param {string} [arg.id] - Field is optional when location_type is
-     *   country. If querying for state, provide id of country. If querying for
-     *   city, provide id of state.
-     * @returns {Promise<Locations>} - Success response
+     * @param {ConfigurationPublicValidator.GetLocationsParam} arg - Arg object.
+     * @param {import("../PublicAPIClient").Options} - Options
+     * @returns {Promise<ConfigurationPublicModel.Locations>} - Success response
+     * @name getLocations
      * @summary: Get countries, states, cities
-     * @description:
+     * @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/getLocations/).
      */
-    getLocations({ locationType, id }?: {
-        locationType?: string;
-        id?: string;
-    }): Promise<Locations>;
+    getLocations({ locationType, id }?: ConfigurationPublicValidator.GetLocationsParam, { headers }?: any): Promise<ConfigurationPublicModel.Locations>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} [arg.authorization] -
-     * @param {string} [arg.query] - Provide application name
-     * @returns {Promise<ApplicationResponse>} - Success response
+     * @param {ConfigurationPublicValidator.SearchApplicationParam} arg - Arg object.
+     * @param {import("../PublicAPIClient").Options} - Options
+     * @returns {Promise<ConfigurationPublicModel.ApplicationResponse>} - Success response
+     * @name searchApplication
      * @summary: Search Application
-     * @description: Provide application name or domain url
+     * @description: Provide application name or domain url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/searchApplication/).
      */
-    searchApplication({ authorization, query }?: {
-        authorization?: string;
-        query?: string;
-    }): Promise<ApplicationResponse>;
+    searchApplication({ authorization, query }?: ConfigurationPublicValidator.SearchApplicationParam, { headers }?: any): Promise<ConfigurationPublicModel.ApplicationResponse>;
 }
+import ConfigurationPublicValidator = require("./ConfigurationPublicValidator");
+import ConfigurationPublicModel = require("./ConfigurationPublicModel");

package/sdk/public/Configuration/ConfigurationPublicClient.js

@@ -2,8 +2,8 @@ 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 ConfigurationPublicValidator = require("./ConfigurationPublicValidator");
+const ConfigurationPublicModel = require("./ConfigurationPublicModel");
 const { Logger } = require("./../../common/Logger");
 const Joi = require("joi");
 
@@ -32,18 +32,18 @@ class Configuration {
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} [arg.locationType] - Provide location type to query on.
-   *   Possible values : country, state, city
-   * @param {string} [arg.id] - Field is optional when location_type is
-   *   country. If querying for state, provide id of country. If querying for
-   *   city, provide id of state.
-   * @returns {Promise<Locations>} - Success response
+   * @param {ConfigurationPublicValidator.GetLocationsParam} arg - Arg object.
+   * @param {import("../PublicAPIClient").Options} - Options
+   * @returns {Promise<ConfigurationPublicModel.Locations>} - Success response
+   * @name getLocations
    * @summary: Get countries, states, cities
-   * @description:
+   * @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/getLocations/).
    */
-  async getLocations({ locationType, id } = {}) {
-    const { error } = ConfigurationValidator.getLocations().validate(
+  async getLocations(
+    { locationType, id } = {},
+    { headers } = { headers: false }
+  ) {
+    const { error } = ConfigurationPublicValidator.getLocations().validate(
       { locationType, id },
       { abortEarly: false, allowUnknown: true }
     );
@@ -52,16 +52,17 @@ class Configuration {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = ConfigurationValidator.getLocations().validate(
+    const {
+      error: warrning,
+    } = ConfigurationPublicValidator.getLocations().validate(
       { locationType, id },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getLocations",
+        message: `Parameter Validation warrnings for public > Configuration > getLocations \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -79,12 +80,18 @@ class Configuration {
       }),
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = ConfigurationModel.Locations().validate(response, {
+    } = ConfigurationPublicModel.Locations().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -92,24 +99,26 @@ class Configuration {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getLocations",
+        message: `Response Validation Warnnings for public > Configuration > getLocations \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} [arg.authorization] -
-   * @param {string} [arg.query] - Provide application name
-   * @returns {Promise<ApplicationResponse>} - Success response
+   * @param {ConfigurationPublicValidator.SearchApplicationParam} arg - Arg object.
+   * @param {import("../PublicAPIClient").Options} - Options
+   * @returns {Promise<ConfigurationPublicModel.ApplicationResponse>} - Success response
+   * @name searchApplication
    * @summary: Search Application
-   * @description: Provide application name or domain url
+   * @description: Provide application name or domain url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/searchApplication/).
    */
-  async searchApplication({ authorization, query } = {}) {
-    const { error } = ConfigurationValidator.searchApplication().validate(
+  async searchApplication(
+    { authorization, query } = {},
+    { headers } = { headers: false }
+  ) {
+    const { error } = ConfigurationPublicValidator.searchApplication().validate(
       { authorization, query },
       { abortEarly: false, allowUnknown: true }
     );
@@ -120,16 +129,15 @@ class Configuration {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = ConfigurationValidator.searchApplication().validate(
+    } = ConfigurationPublicValidator.searchApplication().validate(
       { authorization, query },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for searchApplication",
+        message: `Parameter Validation warrnings for public > Configuration > searchApplication \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -147,12 +155,18 @@ class Configuration {
       }),
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = ConfigurationModel.ApplicationResponse().validate(response, {
+    } = ConfigurationPublicModel.ApplicationResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -160,9 +174,8 @@ class Configuration {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for searchApplication",
+        message: `Response Validation Warnnings for public > Configuration > searchApplication \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;