@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.0.0

package/sdk/application/Webhook/WebhookApplicationClient.d.ts

@@ -10,10 +10,10 @@ declare class Webhook {
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<ClickEventResponse>} - Success response
+     * @returns {Promise<ClickEventDetails>} - Success response
      * @name saveClickEvent
-     * @summary: Endpoint to capture click events from sales channels and persist them in database.
-     * @description: Send click events from sales channels. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/webhook/saveClickEvent/).
+     * @summary: Capture and save click events from various sales channels
+     * @description: Send click events from various sales channels to enable insightful data collection and analysis. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/webhook/saveClickEvent/).
      */
-    saveClickEvent({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ClickEventResponse>;
+    saveClickEvent({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ClickEventDetails>;
 }

package/sdk/application/Webhook/WebhookApplicationClient.js

@@ -6,6 +6,7 @@ const {
 const ApplicationAPIClient = require("../ApplicationAPIClient");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
+const { validateRequiredParams } = require("../../common/Validator");
 
 class Webhook {
   constructor(_conf) {
@@ -33,23 +34,15 @@ class Webhook {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<ClickEventResponse>} - Success response
+   * @returns {Promise<ClickEventDetails>} - Success response
    * @name saveClickEvent
-   * @summary: Endpoint to capture click events from sales channels and persist them in database.
-   * @description: Send click events from sales channels. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/webhook/saveClickEvent/).
+   * @summary: Capture and save click events from various sales channels
+   * @description: Send click events from various sales channels to enable insightful data collection and analysis. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/webhook/saveClickEvent/).
    */
   async saveClickEvent(
     { body, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const query_params = {};
 
     const xHeaders = {};

package/sdk/common/Utility.d.ts

@@ -1,4 +1,4 @@
-export function convertActionToUrl(action: any): any;
+export function convertActionToUrl(action: any, locale: any): any;
 export function convertUrlToAction(url: any): {
     type: string;
     page: {

package/sdk/common/Utility.js

@@ -5,9 +5,12 @@ function convertUrlToAction(url) {
   if (url) {
     const path = utils.trimChar(url);
     const query = utils.getQuery(path);
-    const pathname = utils.validURL(path)
-      ? new URL(path).pathname
-      : path.split("?")[0];
+    let pathname;
+    try {
+      pathname = new URL(path).pathname;
+    } catch (e) {
+      pathname = path.split("?")[0];
+    }
     const allNavigations = Object.assign({}, Constant.NAVIGATORS);
     const typeLink = {};
     for (nav in allNavigations) {
@@ -65,7 +68,7 @@ function convertUrlToAction(url) {
   }
 }
 
-function convertActionToUrl(action) {
+function convertActionToUrl(action, locale) {
   if (action && action.page && action.page.type) {
     switch (action.type) {
       case utils.NAV_TYPE.PAGE: {
@@ -83,16 +86,16 @@ function convertActionToUrl(action) {
             item.link +=
               "/?" + utils.transformRequestOptions(action.page.query);
           }
-          return item.link;
+          return locale ? `/${locale}${item.link}` : item.link;
         }
-        return "";
+        return locale ? `/${locale}` : "";
       }
       case utils.NAV_TYPE.POPUP: {
         break;
       }
     }
   } else {
-    return "";
+    return locale ? `/${locale}` : "";
   }
 }
 

package/sdk/common/Validator.d.ts

@@ -0,0 +1 @@
+export function validateRequiredParams(params: any, requiredParams: any): any[];

package/sdk/common/Validator.js

@@ -0,0 +1,20 @@
+function validateRequiredParams(params, requiredParams) {
+  const errors = [];
+  requiredParams.forEach((key) => {
+    const value = params[key];
+
+    // Reject missing or empty values (except for boolean false)
+    if (
+      value === undefined ||
+      value === null ||
+      (typeof value !== "boolean" && value === "")
+    ) {
+      errors.push(`Missing or empty required parameter: ${key}`);
+    }
+  });
+  return errors;
+}
+
+module.exports = {
+  validateRequiredParams,
+};

package/sdk/common/utils.d.ts

@@ -7,7 +7,6 @@ export function findBestMatchingLink(allLinks?: any[], pathname?: string): {
     value: string;
     params: {};
 };
-export function validURL(str: any): boolean;
 export function convertStringToBase64(string: any): string;
 export function isBrowser(): boolean;
 export function isNode(): boolean;

package/sdk/common/utils.js

@@ -94,19 +94,6 @@ const trimChar = (string = "", charToRemove = "/") => {
   return string;
 };
 
-function validURL(str) {
-  var pattern = new RegExp(
-    "^(https?:\\/\\/)?" + // protocol
-      "((([a-z\\d]([a-z\\d-]*[a-z\\d])*)\\.)+[a-z]{2,}|" + // domain name
-      "((\\d{1,3}\\.){3}\\d{1,3}))" + // OR ip (v4) address
-      "(\\:\\d+)?(\\/[-a-z\\d%_.~+]*)*" + // port and path
-      "(\\?[;&a-z\\d%_.~+=-]*)?" + // query string
-      "(\\#[-a-z\\d_]*)?$",
-    "i"
-  ); // fragment locator
-  return !!pattern.test(str);
-}
-
 const findBestMatchingLink = (allLinks = [], pathname = "/") => {
   let bestMatch = { value: "", params: {} };
   pathname = trimChar(pathname); // -> product/test-product-tag/reviews
@@ -221,7 +208,6 @@ module.exports = {
   trimChar,
   generateUrlWithParams,
   findBestMatchingLink,
-  validURL,
   convertStringToBase64,
   isBrowser,
   isNode,

package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts

@@ -2,31 +2,11 @@ export = FileStorage;
 declare class FileStorage {
     constructor(config: any);
     config: any;
-    /**
-     * @param {FileStoragePartnerValidator.GetAllNamespaceDetailsParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.AllNamespaceDetails>} - Success response
-     * @name getAllNamespaceDetails
-     * @summary: Get details of all namespaces
-     * @description: Retrieve information about all available namespaces - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/getAllNamespaceDetails/).
-     */
-    getAllNamespaceDetails({ requestHeaders }?: FileStoragePartnerValidator.GetAllNamespaceDetailsParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.AllNamespaceDetails>;
-    /**
-     * @param {FileStoragePartnerValidator.GetNamespaceDetailParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.NamespaceDetails>} - Success response
-     * @name getNamespaceDetail
-     * @summary: Get details of a namespace
-     * @description: Retrieve information about a specific namespace - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/getNamespaceDetail/).
-     */
-    getNamespaceDetail({ namespace, requestHeaders }?: FileStoragePartnerValidator.GetNamespaceDetailParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.NamespaceDetails>;
     /**
      * @param {FileStoragePartnerValidator.CompleteUploadParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.CompleteResponse>} - Success response
+     * @returns {Promise<FileStoragePartnerModel.FileUploadComplete>} - Success response
      * @name completeUpload
      * @summary: This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
      * @description: Uploads an arbitrarily sized buffer or blob.
@@ -49,12 +29,12 @@ declare class FileStorage {
      * This operation will return the url for the uploaded file.
      *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/completeUpload/).
      */
-    completeUpload({ namespace, body, requestHeaders }?: FileStoragePartnerValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.CompleteResponse>;
+    completeUpload({ namespace, body, requestHeaders }?: FileStoragePartnerValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.FileUploadComplete>;
     /**
      * @param {FileStoragePartnerValidator.StartUploadParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.StartResponse>} - Success response
+     * @returns {Promise<FileStoragePartnerModel.FileUpload>} - Success response
      * @name startUpload
      * @summary: This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.
      * @description: Uploads an arbitrarily sized buffer or blob.
@@ -77,17 +57,7 @@ declare class FileStorage {
      * This operation will return the url for the uploaded file.
      *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/startUpload/).
      */
-    startUpload({ namespace, body, requestHeaders }?: FileStoragePartnerValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.StartResponse>;
-    /**
-     * @param {FileStoragePartnerValidator.BrowseParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<Object>} - Success response
-     * @name browse
-     * @summary: Browse Files
-     * @description: Browse Files - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/browse/).
-     */
-    browse({ namespace, applicationId, companyId, page, limit, requestHeaders }?: FileStoragePartnerValidator.BrowseParam, { responseHeaders }?: object): Promise<any>;
+    startUpload({ namespace, body, requestHeaders }?: FileStoragePartnerValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.FileUpload>;
     /**
      * @param {FileStoragePartnerValidator.BrowseFilesParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -98,49 +68,35 @@ declare class FileStorage {
      * @description: Browse Files - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/browseFiles/).
      */
     browseFiles({ namespace, page, limit, requestHeaders }?: FileStoragePartnerValidator.BrowseFilesParam, { responseHeaders }?: object): Promise<any>;
-    /**
-     * @param {FileStoragePartnerValidator.OrganizationLevelFetchProxyParam} arg
-     *   - Arg object.
-     *
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.ProxyResponse>} - Success response
-     * @name organizationLevelFetchProxy
-     * @summary: Proxy
-     * @description: Proxy - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/organizationLevelFetchProxy/).
-     */
-    organizationLevelFetchProxy({ applicationId, companyId, url, requestHeaders }?: FileStoragePartnerValidator.OrganizationLevelFetchProxyParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.ProxyResponse>;
-    /**
-     * @param {FileStoragePartnerValidator.SaveOrganizationLevelProxyParam} arg
-     *   - Arg object.
-     *
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.FetchProxyResponse>} - Success response
-     * @name saveOrganizationLevelProxy
-     * @summary: Proxy
-     * @description: Proxy - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/saveOrganizationLevelProxy/).
-     */
-    saveOrganizationLevelProxy({ applicationId, companyId, body, requestHeaders }?: FileStoragePartnerValidator.SaveOrganizationLevelProxyParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.FetchProxyResponse>;
     /**
      * @param {FileStoragePartnerValidator.FetchProxyParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.ProxyResponse>} - Success response
+     * @returns {Promise<FileStoragePartnerModel.FetchProxyDetails>} - Success response
      * @name fetchProxy
      * @summary: Proxy
      * @description: Proxy - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/fetchProxy/).
      */
-    fetchProxy({ url, requestHeaders }?: FileStoragePartnerValidator.FetchProxyParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.ProxyResponse>;
+    fetchProxy({ url, requestHeaders }?: FileStoragePartnerValidator.FetchProxyParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.FetchProxyDetails>;
     /**
      * @param {FileStoragePartnerValidator.SaveProxyDetailsParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.FetchProxyResponse>} - Success response
+     * @returns {Promise<FileStoragePartnerModel.SaveProxy>} - Success response
      * @name saveProxyDetails
      * @summary: Proxy
      * @description: Proxy - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/saveProxyDetails/).
      */
-    saveProxyDetails({ body, requestHeaders }?: FileStoragePartnerValidator.SaveProxyDetailsParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.FetchProxyResponse>;
+    saveProxyDetails({ body, requestHeaders }?: FileStoragePartnerValidator.SaveProxyDetailsParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.SaveProxy>;
+    /**
+     * @param {FileStoragePartnerValidator.SignUrlsParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @returns {Promise<FileStoragePartnerModel.SignUrlResult>} - Success response
+     * @name signUrls
+     * @summary: Get signed URLs.
+     * @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/signUrls/).
+     */
+    signUrls({ body, requestHeaders }?: FileStoragePartnerValidator.SignUrlsParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.SignUrlResult>;
 }
 import FileStoragePartnerModel = require("./FileStoragePartnerModel");