@gofynd/fdk-client-javascript 1.4.15-beta.14 → 1.4.15-beta.15

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

@@ -7,22 +7,24 @@ declare 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
+     * @returns {Promise<PartnerPlatformModel.ExtensionProxyPathCreation>} -
+     *   Success response
      * @name addProxyPath
      * @summary: Create extension proxy
-     * @description: Extension proxy can be used to call extension API from storefront and make extension API integration seamless. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/addProxyPath/).
+     * @description: Use this endpoint to register a proxy for calling an extension's API from your storefront. This enables your storefront to interact with extension APIs seamlessly, helps enhance and extend your storefront's existing functionality using extensions, and simplifies integration by avoiding CORS issues when accessing extension APIs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/addProxyPath/).
      */
-    addProxyPath({ extensionId, body, requestHeaders }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.AddProxyResponse>;
+    addProxyPath({ extensionId, body, requestHeaders }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.ExtensionProxyPathCreation>;
     /**
      * @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
+     * @returns {Promise<PartnerPlatformModel.ExtensionProxyPathDelete>} -
+     *   Success response
      * @name removeProxyPath
      * @summary: Remove extension proxy
-     * @description: Remove the proxy which are created earlier for the extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/removeProxyPath/).
+     * @description: Remove the proxy that was created earlier for the extension. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/removeProxyPath/).
      */
-    removeProxyPath({ extensionId, attachedPath, requestHeaders }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.RemoveProxyResponse>;
+    removeProxyPath({ extensionId, attachedPath, requestHeaders }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.ExtensionProxyPathDelete>;
 }
 import PartnerPlatformApplicationValidator = require("./PartnerPlatformApplicationValidator");
 import PartnerPlatformModel = require("./PartnerPlatformModel");

package/sdk/platform/Partner/PartnerPlatformApplicationClient.js

@@ -19,10 +19,11 @@ 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
+   * @returns {Promise<PartnerPlatformModel.ExtensionProxyPathCreation>} -
+   *   Success response
    * @name addProxyPath
    * @summary: Create extension proxy
-   * @description: Extension proxy can be used to call extension API from storefront and make extension API integration seamless. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/addProxyPath/).
+   * @description: Use this endpoint to register a proxy for calling an extension's API from your storefront. This enables your storefront to interact with extension APIs seamlessly, helps enhance and extend your storefront's existing functionality using extensions, and simplifies integration by avoiding CORS issues when accessing extension APIs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/addProxyPath/).
    */
   async addProxyPath(
     { extensionId, body, requestHeaders } = { requestHeaders: {} },
@@ -77,10 +78,10 @@ class Partner {
 
     const {
       error: res_error,
-    } = PartnerPlatformModel.AddProxyResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
+    } = PartnerPlatformModel.ExtensionProxyPathCreation().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: true }
+    );
 
     if (res_error) {
       if (this.config.options.strictResponseCheck === true) {
@@ -100,10 +101,11 @@ class Partner {
    * @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
+   * @returns {Promise<PartnerPlatformModel.ExtensionProxyPathDelete>} -
+   *   Success response
    * @name removeProxyPath
    * @summary: Remove extension proxy
-   * @description: Remove the proxy which are created earlier for the extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/removeProxyPath/).
+   * @description: Remove the proxy that was created earlier for the extension. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/removeProxyPath/).
    */
   async removeProxyPath(
     { extensionId, attachedPath, requestHeaders } = { requestHeaders: {} },
@@ -158,7 +160,7 @@ class Partner {
 
     const {
       error: res_error,
-    } = PartnerPlatformModel.RemoveProxyResponse().validate(responseData, {
+    } = PartnerPlatformModel.ExtensionProxyPathDelete().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });

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

@@ -1,12 +1,13 @@
 export = PartnerPlatformApplicationValidator;
 /**
  * @typedef AddProxyPathParam
- * @property {string} extensionId - Extension id for which a proxy URL will be generated
+ * @property {string} extensionId - Extension's unique identifier for which a
+ *   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} extensionId - Extension ID for which proxy URL needs to be removed
  * @property {string} attachedPath - Attached path slug
  */
 declare class PartnerPlatformApplicationValidator {
@@ -20,14 +21,15 @@ declare namespace PartnerPlatformApplicationValidator {
 }
 type AddProxyPathParam = {
     /**
-     * - Extension id for which a proxy URL will be generated
+     * - Extension's unique identifier for which a
+     * proxy URL will be generated
      */
     extensionId: string;
     body: PartnerPlatformModel.AddProxyReq;
 };
 type RemoveProxyPathParam = {
     /**
-     * - Extension id for which proxy URL needs to be removed
+     * - Extension ID for which proxy URL needs to be removed
      */
     extensionId: string;
     /**

package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js

@@ -4,13 +4,14 @@ const PartnerPlatformModel = require("./PartnerPlatformModel");
 
 /**
  * @typedef AddProxyPathParam
- * @property {string} extensionId - Extension id for which a proxy URL will be generated
+ * @property {string} extensionId - Extension's unique identifier for which a
+ *   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} extensionId - Extension ID for which proxy URL needs to be removed
  * @property {string} attachedPath - Attached path slug
  */
 

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

@@ -1,25 +1,36 @@
 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
+ * @property {string} [attached_path] - Attached path can be any slug that will
+ *   be appended to the base URL to create a proxy endpoint, e.g.,
+ *   /ext/{attached_path}. Note: attached_path should be unique for each
+ *   extension within the same application.
+ * @property {string} [proxy_url] - External URL for which the proxy URL will be generated
  */
 /**
- * @typedef AddProxyResponse
- * @property {string} [_id]
- * @property {string} [attached_path]
- * @property {string} [proxy_url]
- * @property {string} [company_id]
- * @property {string} [application_id]
- * @property {string} [extension_id]
- * @property {string} [created_at]
- * @property {string} [modified_at]
+ * @typedef ExtensionProxyPathCreation
+ * @property {string} [_id] - Unique identifier for the proxy URL entry in the database.
+ * @property {string} [attached_path] - The slug path appended to the base URL
+ *   for creating the proxy endpoint.
+ * @property {string} [proxy_url] - The external URL that the proxy endpoint
+ *   will forward requests to.
+ * @property {string} [company_id] - Unique identifier of the company that owns
+ *   the proxy URL.
+ * @property {string} [application_id] - Unique identifier of the application
+ *   associated with the proxy URL.
+ * @property {string} [extension_id] - Unique identifier of the extension where
+ *   the proxy URL is configured.
+ * @property {string} [created_at] - The timestamp indicating when the proxy URL
+ *   configuration was created.
+ * @property {string} [modified_at] - The timestamp indicating the last update
+ *   made to the proxy URL configuration.
  */
 /**
- * @typedef RemoveProxyResponse
- * @property {string} [message]
- * @property {Object} [data]
+ * @typedef ExtensionProxyPathDelete
+ * @property {string} [message] - Descriptive message indicating the status or
+ *   result of the deletion operation.
+ * @property {Object} [data] - Additional information or metadata about the
+ *   deleted proxy configuration.
  */
 /**
  * @typedef APIError
@@ -32,37 +43,78 @@ export = PartnerPlatformModel;
 declare class PartnerPlatformModel {
 }
 declare namespace PartnerPlatformModel {
-    export { AddProxyReq, AddProxyResponse, RemoveProxyResponse, APIError };
+    export { AddProxyReq, ExtensionProxyPathCreation, ExtensionProxyPathDelete, APIError };
 }
 /** @returns {AddProxyReq} */
 declare function AddProxyReq(): AddProxyReq;
 type AddProxyReq = {
     /**
-     * - Proxy path slug
+     * - Attached path can be any slug that will
+     * be appended to the base URL to create a proxy endpoint, e.g.,
+     * /ext/{attached_path}. Note: attached_path should be unique for each
+     * extension within the same application.
      */
     attached_path?: string;
     /**
-     * - The external URL for which the proxy URL
-     * will be generated
+     * - External URL for which the proxy URL will be generated
      */
     proxy_url?: string;
 };
-/** @returns {AddProxyResponse} */
-declare function AddProxyResponse(): AddProxyResponse;
-type AddProxyResponse = {
+/** @returns {ExtensionProxyPathCreation} */
+declare function ExtensionProxyPathCreation(): ExtensionProxyPathCreation;
+type ExtensionProxyPathCreation = {
+    /**
+     * - Unique identifier for the proxy URL entry in the database.
+     */
     _id?: string;
+    /**
+     * - The slug path appended to the base URL
+     * for creating the proxy endpoint.
+     */
     attached_path?: string;
+    /**
+     * - The external URL that the proxy endpoint
+     * will forward requests to.
+     */
     proxy_url?: string;
+    /**
+     * - Unique identifier of the company that owns
+     * the proxy URL.
+     */
     company_id?: string;
+    /**
+     * - Unique identifier of the application
+     * associated with the proxy URL.
+     */
     application_id?: string;
+    /**
+     * - Unique identifier of the extension where
+     * the proxy URL is configured.
+     */
     extension_id?: string;
+    /**
+     * - The timestamp indicating when the proxy URL
+     * configuration was created.
+     */
     created_at?: string;
+    /**
+     * - The timestamp indicating the last update
+     * made to the proxy URL configuration.
+     */
     modified_at?: string;
 };
-/** @returns {RemoveProxyResponse} */
-declare function RemoveProxyResponse(): RemoveProxyResponse;
-type RemoveProxyResponse = {
+/** @returns {ExtensionProxyPathDelete} */
+declare function ExtensionProxyPathDelete(): ExtensionProxyPathDelete;
+type ExtensionProxyPathDelete = {
+    /**
+     * - Descriptive message indicating the status or
+     * result of the deletion operation.
+     */
     message?: string;
+    /**
+     * - Additional information or metadata about the
+     * deleted proxy configuration.
+     */
     data?: any;
 };
 /** @returns {APIError} */

package/sdk/platform/Partner/PartnerPlatformModel.js

@@ -2,27 +2,38 @@ const Joi = require("joi");
 
 /**
  * @typedef AddProxyReq
- * @property {string} [attached_path] - Proxy path slug
- * @property {string} [proxy_url] - The external URL for which the proxy URL
- *   will be generated
+ * @property {string} [attached_path] - Attached path can be any slug that will
+ *   be appended to the base URL to create a proxy endpoint, e.g.,
+ *   /ext/{attached_path}. Note: attached_path should be unique for each
+ *   extension within the same application.
+ * @property {string} [proxy_url] - External URL for which the proxy URL will be generated
  */
 
 /**
- * @typedef AddProxyResponse
- * @property {string} [_id]
- * @property {string} [attached_path]
- * @property {string} [proxy_url]
- * @property {string} [company_id]
- * @property {string} [application_id]
- * @property {string} [extension_id]
- * @property {string} [created_at]
- * @property {string} [modified_at]
+ * @typedef ExtensionProxyPathCreation
+ * @property {string} [_id] - Unique identifier for the proxy URL entry in the database.
+ * @property {string} [attached_path] - The slug path appended to the base URL
+ *   for creating the proxy endpoint.
+ * @property {string} [proxy_url] - The external URL that the proxy endpoint
+ *   will forward requests to.
+ * @property {string} [company_id] - Unique identifier of the company that owns
+ *   the proxy URL.
+ * @property {string} [application_id] - Unique identifier of the application
+ *   associated with the proxy URL.
+ * @property {string} [extension_id] - Unique identifier of the extension where
+ *   the proxy URL is configured.
+ * @property {string} [created_at] - The timestamp indicating when the proxy URL
+ *   configuration was created.
+ * @property {string} [modified_at] - The timestamp indicating the last update
+ *   made to the proxy URL configuration.
  */
 
 /**
- * @typedef RemoveProxyResponse
- * @property {string} [message]
- * @property {Object} [data]
+ * @typedef ExtensionProxyPathDelete
+ * @property {string} [message] - Descriptive message indicating the status or
+ *   result of the deletion operation.
+ * @property {Object} [data] - Additional information or metadata about the
+ *   deleted proxy configuration.
  */
 
 /**
@@ -43,8 +54,8 @@ class PartnerPlatformModel {
     });
   }
 
-  /** @returns {AddProxyResponse} */
-  static AddProxyResponse() {
+  /** @returns {ExtensionProxyPathCreation} */
+  static ExtensionProxyPathCreation() {
     return Joi.object({
       _id: Joi.string().allow(""),
       attached_path: Joi.string().allow(""),
@@ -57,11 +68,11 @@ class PartnerPlatformModel {
     });
   }
 
-  /** @returns {RemoveProxyResponse} */
-  static RemoveProxyResponse() {
+  /** @returns {ExtensionProxyPathDelete} */
+  static ExtensionProxyPathDelete() {
     return Joi.object({
       message: Joi.string().allow(""),
-      data: Joi.any(),
+      data: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 
@@ -72,7 +83,7 @@ class PartnerPlatformModel {
       message: Joi.string().allow(""),
       info: Joi.string().allow(""),
       request_id: Joi.string().allow(""),
-      meta: Joi.any(),
+      meta: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 }