@gofynd/fdk-client-javascript 1.2.0 → 1.3.0

package/sdk/platform/Partner/PartnerPlatformApplicationClient.js

@@ -14,6 +14,7 @@ class Partner {
 
   /**
    * @param {PartnerPlatformApplicationValidator.AddProxyPathParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<PartnerPlatformModel.AddProxyResponse>} - Success response
    * @name addProxyPath
@@ -21,8 +22,8 @@ class Partner {
    * @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 } = {},
-    { headers } = { headers: false }
+    { extensionId, body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
   ) {
     const {
       error,
@@ -62,12 +63,12 @@ class Partner {
       `/service/platform/partners/v1.0/company/${this.config.companyId}/application/${this.applicationId}/proxy/${extensionId}`,
       query_params,
       body,
-      undefined,
-      { headers }
+      requestHeaders,
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -88,157 +89,9 @@ class Partner {
     return 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 - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/getProxyPath/).
-   */
-  async getProxyPath({ extensionId } = {}, { headers } = { headers: false }) {
-    const {
-      error,
-    } = PartnerPlatformApplicationValidator.getProxyPath().validate(
-      {
-        extensionId,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = PartnerPlatformApplicationValidator.getProxyPath().validate(
-      {
-        extensionId,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > Partner > getProxyPath \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/partners/v1.0/company/${this.config.companyId}/application/${this.applicationId}/proxy/${extensionId}`,
-      query_params,
-      undefined,
-      undefined,
-      { headers }
-    );
-
-    let responseData = response;
-    if (headers) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = PartnerPlatformModel.getProxyPathRes().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
-
-    if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > Partner > getProxyPath \n ${res_error}`,
-      });
-    }
-
-    return 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 - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/getProxyPathAttachedPath/).
-   */
-  async getProxyPathAttachedPath(
-    { extensionId, attachedPath } = {},
-    { headers } = { headers: false }
-  ) {
-    const {
-      error,
-    } = PartnerPlatformApplicationValidator.getProxyPathAttachedPath().validate(
-      {
-        extensionId,
-        attachedPath,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = PartnerPlatformApplicationValidator.getProxyPathAttachedPath().validate(
-      {
-        extensionId,
-        attachedPath,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > Partner > getProxyPathAttachedPath \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/partners/v1.0/company/${this.config.companyId}/application/${this.applicationId}/proxy/${extensionId}/${attachedPath}`,
-      query_params,
-      undefined,
-      undefined,
-      { headers }
-    );
-
-    let responseData = response;
-    if (headers) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = PartnerPlatformModel.AddProxyResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
-
-    if (res_error) {
-      Logger({
-        level: "WARN",
-        message: `Response Validation Warnnings for platform > Partner > getProxyPathAttachedPath \n ${res_error}`,
-      });
-    }
-
-    return response;
-  }
-
   /**
    * @param {PartnerPlatformApplicationValidator.RemoveProxyPathParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<PartnerPlatformModel.RemoveProxyResponse>} - Success response
    * @name removeProxyPath
@@ -246,8 +99,8 @@ class Partner {
    * @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 } = {},
-    { headers } = { headers: false }
+    { extensionId, attachedPath, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
   ) {
     const {
       error,
@@ -287,12 +140,12 @@ class Partner {
       `/service/platform/partners/v1.0/company/${this.config.companyId}/application/${this.applicationId}/proxy/${extensionId}/${attachedPath}`,
       query_params,
       undefined,
-      undefined,
-      { headers }
+      requestHeaders,
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 

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

@@ -4,15 +4,6 @@ export = PartnerPlatformApplicationValidator;
  * @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
@@ -21,15 +12,11 @@ export = PartnerPlatformApplicationValidator;
 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 };
+    export { AddProxyPathParam, RemoveProxyPathParam };
 }
 type AddProxyPathParam = {
     /**
@@ -38,22 +25,6 @@ type AddProxyPathParam = {
     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

package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js

@@ -8,17 +8,6 @@ const PartnerPlatformModel = require("./PartnerPlatformModel");
  * @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
@@ -34,21 +23,6 @@ class PartnerPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {GetProxyPathParam} */
-  static getProxyPath() {
-    return Joi.object({
-      extensionId: Joi.string().allow(""),
-    }).required();
-  }
-
-  /** @returns {GetProxyPathAttachedPathParam} */
-  static getProxyPathAttachedPath() {
-    return Joi.object({
-      extensionId: Joi.string().allow(""),
-      attachedPath: Joi.string().allow(""),
-    }).required();
-  }
-
   /** @returns {RemoveProxyPathParam} */
   static removeProxyPath() {
     return Joi.object({