@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/platform/Partner/PartnerPlatformApplicationClient.js

@@ -1,8 +1,8 @@
 const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const Paginator = require("../../common/Paginator");
-const PartnerValidator = require("./PartnerPlatformApplicationValidator");
-const PartnerModel = require("./PartnerPlatformModel");
+const PartnerPlatformApplicationValidator = require("./PartnerPlatformApplicationValidator");
+const PartnerPlatformModel = require("./PartnerPlatformModel");
 const { Logger } = require("./../../common/Logger");
 const Joi = require("joi");
 
@@ -13,16 +13,20 @@ class Partner {
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.extensionId - Extension id for which proxy URL will
-   *   be generated
-   * @param {AddProxyReq} arg.body
-   * @returns {Promise<AddProxyResponse>} - Success response
+   * @param {PartnerPlatformApplicationValidator.AddProxyPathParam} arg - Arg object
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<PartnerPlatformModel.AddProxyResponse>} - Success response
+   * @name addProxyPath
    * @summary: Create proxy URL for the external URL
-   * @description: Use this API to generate proxy URL for the external URL
+   * @description: Use this API to generate proxy URL for the external URL - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/addProxyPath/).
    */
-  async addProxyPath({ extensionId, body } = {}) {
-    const { error } = PartnerValidator.addProxyPath().validate(
+  async addProxyPath(
+    { extensionId, body } = {},
+    { headers } = { headers: false }
+  ) {
+    const {
+      error,
+    } = PartnerPlatformApplicationValidator.addProxyPath().validate(
       {
         extensionId,
         body,
@@ -34,7 +38,9 @@ class Partner {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = PartnerValidator.addProxyPath().validate(
+    const {
+      error: warrning,
+    } = PartnerPlatformApplicationValidator.addProxyPath().validate(
       {
         extensionId,
         body,
@@ -44,9 +50,8 @@ class Partner {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for addProxyPath",
+        message: `Parameter Validation warrnings for platform > Partner > addProxyPath \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -56,12 +61,19 @@ class Partner {
       "post",
       `/service/platform/partners/v1.0/company/${this.config.companyId}/application/${this.applicationId}/proxy/${extensionId}`,
       query_params,
-      body
+      body,
+      undefined,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = PartnerModel.AddProxyResponse().validate(response, {
+    } = PartnerPlatformModel.AddProxyResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -69,23 +81,25 @@ class Partner {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for addProxyPath",
+        message: `Response Validation Warnnings for platform > Partner > addProxyPath \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} [arg.extensionId] - Extension id
-   * @returns {Promise<getProxyPathRes>} - Success response
+   * @param {PartnerPlatformApplicationValidator.GetProxyPathParam} arg - Arg object
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<PartnerPlatformModel.getProxyPathRes>} - Success response
+   * @name getProxyPath
    * @summary: Proxy
-   * @description: Use this API to get proxy url
+   * @description: Use this API to get proxy url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/getProxyPath/).
    */
-  async getProxyPath({ extensionId } = {}) {
-    const { error } = PartnerValidator.getProxyPath().validate(
+  async getProxyPath({ extensionId } = {}, { headers } = { headers: false }) {
+    const {
+      error,
+    } = PartnerPlatformApplicationValidator.getProxyPath().validate(
       {
         extensionId,
       },
@@ -96,7 +110,9 @@ class Partner {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = PartnerValidator.getProxyPath().validate(
+    const {
+      error: warrning,
+    } = PartnerPlatformApplicationValidator.getProxyPath().validate(
       {
         extensionId,
       },
@@ -105,9 +121,8 @@ class Partner {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getProxyPath",
+        message: `Parameter Validation warrnings for platform > Partner > getProxyPath \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -117,12 +132,19 @@ class Partner {
       "get",
       `/service/platform/partners/v1.0/company/${this.config.companyId}/application/${this.applicationId}/proxy/${extensionId}`,
       query_params,
-      undefined
+      undefined,
+      undefined,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = PartnerModel.getProxyPathRes().validate(response, {
+    } = PartnerPlatformModel.getProxyPathRes().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -130,24 +152,30 @@ class Partner {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getProxyPath",
+        message: `Response Validation Warnnings for platform > Partner > getProxyPath \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} [arg.extensionId] - Extension id
-   * @param {string} [arg.attachedPath] - Application id
-   * @returns {Promise<AddProxyResponse>} - Success response
+   * @param {PartnerPlatformApplicationValidator.GetProxyPathAttachedPathParam} arg
+   *   - Arg object
+   *
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<PartnerPlatformModel.AddProxyResponse>} - Success response
+   * @name getProxyPathAttachedPath
    * @summary: Proxy
-   * @description: Use this API to get proxy url
+   * @description: Use this API to get proxy url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/getProxyPathAttachedPath/).
    */
-  async getProxyPathAttachedPath({ extensionId, attachedPath } = {}) {
-    const { error } = PartnerValidator.getProxyPathAttachedPath().validate(
+  async getProxyPathAttachedPath(
+    { extensionId, attachedPath } = {},
+    { headers } = { headers: false }
+  ) {
+    const {
+      error,
+    } = PartnerPlatformApplicationValidator.getProxyPathAttachedPath().validate(
       {
         extensionId,
         attachedPath,
@@ -161,7 +189,7 @@ class Partner {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = PartnerValidator.getProxyPathAttachedPath().validate(
+    } = PartnerPlatformApplicationValidator.getProxyPathAttachedPath().validate(
       {
         extensionId,
         attachedPath,
@@ -171,9 +199,8 @@ class Partner {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getProxyPathAttachedPath",
+        message: `Parameter Validation warrnings for platform > Partner > getProxyPathAttachedPath \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -183,12 +210,19 @@ class Partner {
       "get",
       `/service/platform/partners/v1.0/company/${this.config.companyId}/application/${this.applicationId}/proxy/${extensionId}/${attachedPath}`,
       query_params,
-      undefined
+      undefined,
+      undefined,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = PartnerModel.AddProxyResponse().validate(response, {
+    } = PartnerPlatformModel.AddProxyResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -196,25 +230,28 @@ class Partner {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getProxyPathAttachedPath",
+        message: `Response Validation Warnnings for platform > Partner > getProxyPathAttachedPath \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.extensionId - Extension id for which proxy URL needs
-   *   to be removed
-   * @param {string} arg.attachedPath - Attachaed path slug
-   * @returns {Promise<RemoveProxyResponse>} - Success response
+   * @param {PartnerPlatformApplicationValidator.RemoveProxyPathParam} arg - Arg object
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<PartnerPlatformModel.RemoveProxyResponse>} - Success response
+   * @name removeProxyPath
    * @summary: Remove proxy URL for the external URL
-   * @description: Use this API to remove the proxy URL which is already generated for the external URL
+   * @description: Use this API to remove the proxy URL which is already generated for the external URL - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/removeProxyPath/).
    */
-  async removeProxyPath({ extensionId, attachedPath } = {}) {
-    const { error } = PartnerValidator.removeProxyPath().validate(
+  async removeProxyPath(
+    { extensionId, attachedPath } = {},
+    { headers } = { headers: false }
+  ) {
+    const {
+      error,
+    } = PartnerPlatformApplicationValidator.removeProxyPath().validate(
       {
         extensionId,
         attachedPath,
@@ -226,7 +263,9 @@ class Partner {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = PartnerValidator.removeProxyPath().validate(
+    const {
+      error: warrning,
+    } = PartnerPlatformApplicationValidator.removeProxyPath().validate(
       {
         extensionId,
         attachedPath,
@@ -236,9 +275,8 @@ class Partner {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for removeProxyPath",
+        message: `Parameter Validation warrnings for platform > Partner > removeProxyPath \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -248,12 +286,19 @@ class Partner {
       "delete",
       `/service/platform/partners/v1.0/company/${this.config.companyId}/application/${this.applicationId}/proxy/${extensionId}/${attachedPath}`,
       query_params,
-      undefined
+      undefined,
+      undefined,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = PartnerModel.RemoveProxyResponse().validate(response, {
+    } = PartnerPlatformModel.RemoveProxyResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -261,9 +306,8 @@ class Partner {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for removeProxyPath",
+        message: `Response Validation Warnnings for platform > Partner > removeProxyPath \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;

package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts

@@ -1,7 +1,67 @@
-export = PartnerValidator;
-declare class PartnerValidator {
-    static addProxyPath(): any;
-    static getProxyPath(): any;
-    static getProxyPathAttachedPath(): any;
-    static removeProxyPath(): any;
+export = PartnerPlatformApplicationValidator;
+/**
+ * @typedef AddProxyPathParam
+ * @property {string} extensionId - Extension id for which proxy URL will be generated
+ * @property {PartnerPlatformModel.AddProxyReq} body
+ */
+/**
+ * @typedef GetProxyPathParam
+ * @property {string} [extensionId] - Extension id
+ */
+/**
+ * @typedef GetProxyPathAttachedPathParam
+ * @property {string} [extensionId] - Extension id
+ * @property {string} [attachedPath] - Application id
+ */
+/**
+ * @typedef RemoveProxyPathParam
+ * @property {string} extensionId - Extension id for which proxy URL needs to be removed
+ * @property {string} attachedPath - Attachaed path slug
+ */
+declare class PartnerPlatformApplicationValidator {
+    /** @returns {AddProxyPathParam} */
+    static addProxyPath(): AddProxyPathParam;
+    /** @returns {GetProxyPathParam} */
+    static getProxyPath(): GetProxyPathParam;
+    /** @returns {GetProxyPathAttachedPathParam} */
+    static getProxyPathAttachedPath(): GetProxyPathAttachedPathParam;
+    /** @returns {RemoveProxyPathParam} */
+    static removeProxyPath(): RemoveProxyPathParam;
 }
+declare namespace PartnerPlatformApplicationValidator {
+    export { AddProxyPathParam, GetProxyPathParam, GetProxyPathAttachedPathParam, RemoveProxyPathParam };
+}
+type AddProxyPathParam = {
+    /**
+     * - Extension id for which proxy URL will be generated
+     */
+    extensionId: string;
+    body: PartnerPlatformModel.AddProxyReq;
+};
+type GetProxyPathParam = {
+    /**
+     * - Extension id
+     */
+    extensionId?: string;
+};
+type GetProxyPathAttachedPathParam = {
+    /**
+     * - Extension id
+     */
+    extensionId?: string;
+    /**
+     * - Application id
+     */
+    attachedPath?: string;
+};
+type RemoveProxyPathParam = {
+    /**
+     * - Extension id for which proxy URL needs to be removed
+     */
+    extensionId: string;
+    /**
+     * - Attachaed path slug
+     */
+    attachedPath: string;
+};
+import PartnerPlatformModel = require("./PartnerPlatformModel");

package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js

@@ -1,20 +1,47 @@
 const Joi = require("joi");
 
-const PartnerModel = require("./PartnerPlatformModel");
-class PartnerValidator {
+const PartnerPlatformModel = require("./PartnerPlatformModel");
+
+/**
+ * @typedef AddProxyPathParam
+ * @property {string} extensionId - Extension id for which proxy URL will be generated
+ * @property {PartnerPlatformModel.AddProxyReq} body
+ */
+
+/**
+ * @typedef GetProxyPathParam
+ * @property {string} [extensionId] - Extension id
+ */
+
+/**
+ * @typedef GetProxyPathAttachedPathParam
+ * @property {string} [extensionId] - Extension id
+ * @property {string} [attachedPath] - Application id
+ */
+
+/**
+ * @typedef RemoveProxyPathParam
+ * @property {string} extensionId - Extension id for which proxy URL needs to be removed
+ * @property {string} attachedPath - Attachaed path slug
+ */
+
+class PartnerPlatformApplicationValidator {
+  /** @returns {AddProxyPathParam} */
   static addProxyPath() {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
-      body: PartnerModel.AddProxyReq().required(),
+      body: PartnerPlatformModel.AddProxyReq().required(),
     }).required();
   }
 
+  /** @returns {GetProxyPathParam} */
   static getProxyPath() {
     return Joi.object({
       extensionId: Joi.string().allow(""),
     }).required();
   }
 
+  /** @returns {GetProxyPathAttachedPathParam} */
   static getProxyPathAttachedPath() {
     return Joi.object({
       extensionId: Joi.string().allow(""),
@@ -22,6 +49,7 @@ class PartnerValidator {
     }).required();
   }
 
+  /** @returns {RemoveProxyPathParam} */
   static removeProxyPath() {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
@@ -30,4 +58,4 @@ class PartnerValidator {
   }
 }
 
-module.exports = PartnerValidator;
+module.exports = PartnerPlatformApplicationValidator;