@gofynd/fdk-client-javascript 1.4.15-beta.2 → 1.4.15

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

@@ -8,15 +8,12 @@ declare class Webhook {
     _urls: {};
     updateUrls(urls: any): void;
     /**
-     * @param {WebhookApplicationValidator.SaveClickEventParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<WebhookApplicationModel.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 }?: WebhookApplicationValidator.SaveClickEventParam, { responseHeaders }?: object): Promise<WebhookApplicationModel.ClickEventResponse>;
+    saveClickEvent({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ClickEventDetails>;
 }
-import WebhookApplicationValidator = require("./WebhookApplicationValidator");
-import WebhookApplicationModel = require("./WebhookApplicationModel");

package/sdk/application/Webhook/WebhookApplicationClient.js

@@ -1,14 +1,6 @@
 const ApplicationAPIClient = require("../ApplicationAPIClient");
-const {
-  FDKClientValidationError,
-  FDKResponseValidationError,
-} = require("../../common/FDKError");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
-const WebhookApplicationValidator = require("./WebhookApplicationValidator");
-const WebhookApplicationModel = require("./WebhookApplicationModel");
-const { Logger } = require("./../../common/Logger");
-const Joi = require("joi");
 
 class Webhook {
   constructor(_conf) {
@@ -34,40 +26,17 @@ class Webhook {
   }
 
   /**
-   * @param {WebhookApplicationValidator.SaveClickEventParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<WebhookApplicationModel.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 }
   ) {
-    const { error } = WebhookApplicationValidator.saveClickEvent().validate(
-      { body },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = WebhookApplicationValidator.saveClickEvent().validate(
-      { body },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for application > Webhook > saveClickEvent \n ${warrning}`,
-      });
-    }
-
     const query_params = {};
 
     const xHeaders = {};
@@ -90,24 +59,6 @@ class Webhook {
       responseData = response[0];
     }
 
-    const {
-      error: res_error,
-    } = WebhookApplicationModel.ClickEventResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-
-    if (res_error) {
-      if (this._conf.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for application > Webhook > saveClickEvent \n ${res_error}`,
-        });
-      }
-    }
-
     return response;
   }
 }

package/sdk/application/index.d.ts

@@ -1,20 +1,2 @@
 export const ApplicationConfig: typeof import("./ApplicationConfig");
 export const ApplicationClient: typeof import("./ApplicationClient");
-export namespace ApplicationModel {
-    const CartApplicationModel: typeof import("./Cart/CartApplicationModel");
-    const CatalogApplicationModel: typeof import("./Catalog/CatalogApplicationModel");
-    const CommonApplicationModel: typeof import("./Common/CommonApplicationModel");
-    const CommunicationApplicationModel: typeof import("./Communication/CommunicationApplicationModel");
-    const ConfigurationApplicationModel: typeof import("./Configuration/ConfigurationApplicationModel");
-    const ContentApplicationModel: typeof import("./Content/ContentApplicationModel");
-    const FileStorageApplicationModel: typeof import("./FileStorage/FileStorageApplicationModel");
-    const LeadApplicationModel: typeof import("./Lead/LeadApplicationModel");
-    const LogisticApplicationModel: typeof import("./Logistic/LogisticApplicationModel");
-    const OrderApplicationModel: typeof import("./Order/OrderApplicationModel");
-    const PaymentApplicationModel: typeof import("./Payment/PaymentApplicationModel");
-    const RewardsApplicationModel: typeof import("./Rewards/RewardsApplicationModel");
-    const ShareApplicationModel: typeof import("./Share/ShareApplicationModel");
-    const ThemeApplicationModel: typeof import("./Theme/ThemeApplicationModel");
-    const UserApplicationModel: typeof import("./User/UserApplicationModel");
-    const WebhookApplicationModel: typeof import("./Webhook/WebhookApplicationModel");
-}

package/sdk/application/index.js

@@ -1,37 +1,4 @@
 module.exports = {
   ApplicationConfig: require("./ApplicationConfig"),
   ApplicationClient: require("./ApplicationClient"),
-  ApplicationModel: {
-    CartApplicationModel: require("./Cart/CartApplicationModel"),
-
-    CatalogApplicationModel: require("./Catalog/CatalogApplicationModel"),
-
-    CommonApplicationModel: require("./Common/CommonApplicationModel"),
-
-    CommunicationApplicationModel: require("./Communication/CommunicationApplicationModel"),
-
-    ConfigurationApplicationModel: require("./Configuration/ConfigurationApplicationModel"),
-
-    ContentApplicationModel: require("./Content/ContentApplicationModel"),
-
-    FileStorageApplicationModel: require("./FileStorage/FileStorageApplicationModel"),
-
-    LeadApplicationModel: require("./Lead/LeadApplicationModel"),
-
-    LogisticApplicationModel: require("./Logistic/LogisticApplicationModel"),
-
-    OrderApplicationModel: require("./Order/OrderApplicationModel"),
-
-    PaymentApplicationModel: require("./Payment/PaymentApplicationModel"),
-
-    RewardsApplicationModel: require("./Rewards/RewardsApplicationModel"),
-
-    ShareApplicationModel: require("./Share/ShareApplicationModel"),
-
-    ThemeApplicationModel: require("./Theme/ThemeApplicationModel"),
-
-    UserApplicationModel: require("./User/UserApplicationModel"),
-
-    WebhookApplicationModel: require("./Webhook/WebhookApplicationModel"),
-  },
 };

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

@@ -3,12 +3,32 @@ declare class FileStorage {
     constructor(config: any);
     config: any;
     /**
-     * @param {FileStoragePartnerValidator.StartUploadParam} arg - Arg object.
+     * @param {FileStoragePartnerValidator.GetAllNamespaceDetailsParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.StartResponse>} - 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
+     * @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.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.
      *
      * It has three Major Steps:
@@ -27,16 +47,16 @@ declare class FileStorage {
      * ### Complete
      * After successfully upload, call `completeUpload` api to complete the upload process.
      * This operation will return the url for the uploaded file.
-     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/startUpload/).
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/completeUpload/).
      */
-    startUpload({ namespace, body, requestHeaders }?: FileStoragePartnerValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.StartResponse>;
+    completeUpload({ namespace, body, requestHeaders }?: FileStoragePartnerValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.FileUploadComplete>;
     /**
-     * @param {FileStoragePartnerValidator.CompleteUploadParam} arg - Arg object.
+     * @param {FileStoragePartnerValidator.StartUploadParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.CompleteResponse>} - 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
+     * @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.
      *
      * It has three Major Steps:
@@ -55,9 +75,9 @@ declare class FileStorage {
      * ### Complete
      * After successfully upload, call `completeUpload` api to complete the upload process.
      * This operation will return the url for the uploaded file.
-     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/completeUpload/).
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/startUpload/).
      */
-    completeUpload({ namespace, body, requestHeaders }?: FileStoragePartnerValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.CompleteResponse>;
+    startUpload({ namespace, body, requestHeaders }?: FileStoragePartnerValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.FileUpload>;
     /**
      * @param {FileStoragePartnerValidator.BrowseParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -68,5 +88,59 @@ declare class FileStorage {
      * @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>;
+    /**
+     * @param {FileStoragePartnerValidator.BrowseFilesParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @returns {Promise<Object>} - Success response
+     * @name browseFiles
+     * @summary: Browse Files
+     * @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.FetchProxyDetails>} - 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.FetchProxyDetails>;
+    /**
+     * @param {FileStoragePartnerValidator.SaveOrganizationLevelProxyParam} arg
+     *   - Arg object.
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @returns {Promise<FileStoragePartnerModel.SaveProxy>} - 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.SaveProxy>;
+    /**
+     * @param {FileStoragePartnerValidator.FetchProxyParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @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.FetchProxyDetails>;
+    /**
+     * @param {FileStoragePartnerValidator.SaveProxyDetailsParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @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.SaveProxy>;
 }
 import FileStoragePartnerModel = require("./FileStoragePartnerModel");