@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

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

@@ -4,51 +4,25 @@ declare class Partner {
     config: any;
     applicationId: any;
     /**
-     * @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 {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @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/).
      */
-    addProxyPath({ extensionId, body }?: {
-        extensionId: string;
-        body: AddProxyReq;
-    }): Promise<AddProxyResponse>;
+    addProxyPath({ extensionId, body, requestHeaders }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.AddProxyResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} [arg.extensionId] - Extension id
-     * @returns {Promise<getProxyPathRes>} - Success response
-     * @summary: Proxy
-     * @description: Use this API to get proxy url
-     */
-    getProxyPath({ extensionId }?: {
-        extensionId?: string;
-    }): Promise<getProxyPathRes>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} [arg.extensionId] - Extension id
-     * @param {string} [arg.attachedPath] - Application id
-     * @returns {Promise<AddProxyResponse>} - Success response
-     * @summary: Proxy
-     * @description: Use this API to get proxy url
-     */
-    getProxyPathAttachedPath({ extensionId, attachedPath }?: {
-        extensionId?: string;
-        attachedPath?: string;
-    }): Promise<AddProxyResponse>;
-    /**
-     * @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 {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @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/).
      */
-    removeProxyPath({ extensionId, attachedPath }?: {
-        extensionId: string;
-        attachedPath: string;
-    }): Promise<RemoveProxyResponse>;
+    removeProxyPath({ extensionId, attachedPath, requestHeaders }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.RemoveProxyResponse>;
 }
+import PartnerPlatformApplicationValidator = require("./PartnerPlatformApplicationValidator");
+import PartnerPlatformModel = require("./PartnerPlatformModel");

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,21 @@ 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 {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @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, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = PartnerPlatformApplicationValidator.addProxyPath().validate(
       {
         extensionId,
         body,
@@ -34,7 +39,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 +51,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,73 +62,19 @@ class Partner {
       "post",
       `/service/platform/partners/v1.0/company/${this.config.companyId}/application/${this.applicationId}/proxy/${extensionId}`,
       query_params,
-      body
+      body,
+      requestHeaders,
+      { responseHeaders }
     );
 
-    const {
-      error: res_error,
-    } = PartnerModel.AddProxyResponse().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
-
-    if (res_error) {
-      Logger({
-        level: "WARN",
-        message: "Response Validation Warnnings for addProxyPath",
-      });
-      Logger({ level: "WARN", message: res_error });
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
     }
 
-    return response;
-  }
-
-  /**
-   * @param {Object} arg - Arg object.
-   * @param {string} [arg.extensionId] - Extension id
-   * @returns {Promise<getProxyPathRes>} - Success response
-   * @summary: Proxy
-   * @description: Use this API to get proxy url
-   */
-  async getProxyPath({ extensionId } = {}) {
-    const { error } = PartnerValidator.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 } = PartnerValidator.getProxyPath().validate(
-      {
-        extensionId,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: "Parameter Validation warrnings for getProxyPath",
-      });
-      Logger({ level: "WARN", message: 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
-    );
-
     const {
       error: res_error,
-    } = PartnerModel.getProxyPathRes().validate(response, {
+    } = PartnerPlatformModel.AddProxyResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -130,24 +82,29 @@ class Partner {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getProxyPath",
+        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
-   * @param {string} [arg.attachedPath] - Application id
-   * @returns {Promise<AddProxyResponse>} - Success response
-   * @summary: Proxy
-   * @description: Use this API to get proxy url
+   * @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
+   * @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 - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/removeProxyPath/).
    */
-  async getProxyPathAttachedPath({ extensionId, attachedPath } = {}) {
-    const { error } = PartnerValidator.getProxyPathAttachedPath().validate(
+  async removeProxyPath(
+    { extensionId, attachedPath, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = PartnerPlatformApplicationValidator.removeProxyPath().validate(
       {
         extensionId,
         attachedPath,
@@ -161,7 +118,7 @@ class Partner {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = PartnerValidator.getProxyPathAttachedPath().validate(
+    } = PartnerPlatformApplicationValidator.removeProxyPath().validate(
       {
         extensionId,
         attachedPath,
@@ -171,89 +128,30 @@ class Partner {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getProxyPathAttachedPath",
+        message: `Parameter Validation warrnings for platform > Partner > removeProxyPath \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
 
     const response = await PlatformAPIClient.execute(
       this.config,
-      "get",
+      "delete",
       `/service/platform/partners/v1.0/company/${this.config.companyId}/application/${this.applicationId}/proxy/${extensionId}/${attachedPath}`,
       query_params,
-      undefined
+      undefined,
+      requestHeaders,
+      { responseHeaders }
     );
 
-    const {
-      error: res_error,
-    } = PartnerModel.AddProxyResponse().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
-
-    if (res_error) {
-      Logger({
-        level: "WARN",
-        message: "Response Validation Warnnings for getProxyPathAttachedPath",
-      });
-      Logger({ level: "WARN", message: res_error });
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
     }
 
-    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
-   * @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
-   */
-  async removeProxyPath({ extensionId, attachedPath } = {}) {
-    const { error } = PartnerValidator.removeProxyPath().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 } = PartnerValidator.removeProxyPath().validate(
-      {
-        extensionId,
-        attachedPath,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: "Parameter Validation warrnings for removeProxyPath",
-      });
-      Logger({ level: "WARN", message: warrning });
-    }
-
-    const query_params = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "delete",
-      `/service/platform/partners/v1.0/company/${this.config.companyId}/application/${this.applicationId}/proxy/${extensionId}/${attachedPath}`,
-      query_params,
-      undefined
-    );
-
     const {
       error: res_error,
-    } = PartnerModel.RemoveProxyResponse().validate(response, {
+    } = PartnerPlatformModel.RemoveProxyResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -261,9 +159,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,38 @@
-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 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 {RemoveProxyPathParam} */
+    static removeProxyPath(): RemoveProxyPathParam;
 }
+declare namespace PartnerPlatformApplicationValidator {
+    export { AddProxyPathParam, RemoveProxyPathParam };
+}
+type AddProxyPathParam = {
+    /**
+     * - Extension id for which proxy URL will be generated
+     */
+    extensionId: string;
+    body: PartnerPlatformModel.AddProxyReq;
+};
+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,27 +1,29 @@
 const Joi = require("joi");
 
-const PartnerModel = require("./PartnerPlatformModel");
-class PartnerValidator {
-  static addProxyPath() {
-    return Joi.object({
-      extensionId: Joi.string().allow("").required(),
-      body: PartnerModel.AddProxyReq().required(),
-    }).required();
-  }
+const PartnerPlatformModel = require("./PartnerPlatformModel");
 
-  static getProxyPath() {
-    return Joi.object({
-      extensionId: Joi.string().allow(""),
-    }).required();
-  }
+/**
+ * @typedef AddProxyPathParam
+ * @property {string} extensionId - Extension id for which proxy URL will be generated
+ * @property {PartnerPlatformModel.AddProxyReq} body
+ */
+
+/**
+ * @typedef RemoveProxyPathParam
+ * @property {string} extensionId - Extension id for which proxy URL needs to be removed
+ * @property {string} attachedPath - Attachaed path slug
+ */
 
-  static getProxyPathAttachedPath() {
+class PartnerPlatformApplicationValidator {
+  /** @returns {AddProxyPathParam} */
+  static addProxyPath() {
     return Joi.object({
-      extensionId: Joi.string().allow(""),
-      attachedPath: Joi.string().allow(""),
+      extensionId: Joi.string().allow("").required(),
+      body: PartnerPlatformModel.AddProxyReq().required(),
     }).required();
   }
 
+  /** @returns {RemoveProxyPathParam} */
   static removeProxyPath() {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
@@ -30,4 +32,4 @@ class PartnerValidator {
   }
 }
 
-module.exports = PartnerValidator;
+module.exports = PartnerPlatformApplicationValidator;

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

@@ -1,46 +1,79 @@
-export = PartnerModel;
-declare class PartnerModel {
-    static AddProxyReq(): any;
-    static AddProxyResponse(): any;
-    static APIError(): any;
-    static ApplicationPermissions(): any;
-    static ApprovedPermissions(): any;
-    static ApprovedPermissionsInfo(): any;
-    static Benefits(): any;
-    static Callback(): any;
-    static Category(): any;
-    static CategoryL1(): any;
-    static CategoryL2(): any;
-    static CommingSoon(): any;
-    static ContactInfo(): any;
-    static ExtensionCommon(): any;
-    static ExtensionDetails(): any;
-    static ExtensionItems(): any;
-    static ExtensionList(): any;
-    static ExtensionListItems(): any;
-    static ExtensionResponse(): any;
-    static ExtensionSuggestion(): any;
-    static ExtensionSuggestionList(): any;
-    static getProxyPathRes(): any;
-    static ListingInfo(): any;
-    static Logo(): any;
-    static ModifyPartnerReq(): any;
-    static OrganizationBasicInfo(): any;
-    static Pagination(): any;
-    static PartnerInviteDetails(): any;
-    static PartnerList(): any;
-    static PartnerRequestList(): any;
-    static Plan(): any;
-    static Plans(): any;
-    static Price(): any;
-    static PublicExtension(): any;
-    static RemoveProxyResponse(): any;
-    static RequestedPermissions(): any;
-    static Scope(): any;
-    static Screenshots(): any;
-    static SetupProductRes(): any;
-    static SubscriptionRequest(): any;
-    static SubscriptionRes(): any;
-    static Support(): any;
-    static UninstallExtension(): any;
+export = PartnerPlatformModel;
+/**
+ * @typedef AddProxyReq
+ * @property {string} [attached_path] - Proxy path slug
+ * @property {string} [proxy_url] - The external URL for which the proxy URL
+ *   will be generated
+ */
+/**
+ * @typedef AddProxyResponse
+ * @property {string} [_id]
+ * @property {string} [application_id]
+ * @property {string} [attached_path]
+ * @property {string} [company_id]
+ * @property {string} [created_at]
+ * @property {string} [extension_id]
+ * @property {string} [modified_at]
+ * @property {string} [proxy_url]
+ */
+/**
+ * @typedef APIError
+ * @property {string} [code]
+ * @property {string} [info] - Error code description link
+ * @property {string} [message]
+ * @property {Object} [meta]
+ * @property {string} [request_id]
+ */
+/**
+ * @typedef RemoveProxyResponse
+ * @property {Object} [data]
+ * @property {string} [message]
+ */
+declare class PartnerPlatformModel {
 }
+declare namespace PartnerPlatformModel {
+    export { AddProxyReq, AddProxyResponse, APIError, RemoveProxyResponse };
+}
+/** @returns {AddProxyReq} */
+declare function AddProxyReq(): AddProxyReq;
+type AddProxyReq = {
+    /**
+     * - Proxy path slug
+     */
+    attached_path?: string;
+    /**
+     * - The external URL for which the proxy URL
+     * will be generated
+     */
+    proxy_url?: string;
+};
+/** @returns {AddProxyResponse} */
+declare function AddProxyResponse(): AddProxyResponse;
+type AddProxyResponse = {
+    _id?: string;
+    application_id?: string;
+    attached_path?: string;
+    company_id?: string;
+    created_at?: string;
+    extension_id?: string;
+    modified_at?: string;
+    proxy_url?: string;
+};
+/** @returns {APIError} */
+declare function APIError(): APIError;
+type APIError = {
+    code?: string;
+    /**
+     * - Error code description link
+     */
+    info?: string;
+    message?: string;
+    meta?: any;
+    request_id?: string;
+};
+/** @returns {RemoveProxyResponse} */
+declare function RemoveProxyResponse(): RemoveProxyResponse;
+type RemoveProxyResponse = {
+    data?: any;
+    message?: string;
+};