@gofynd/fdk-client-javascript 1.4.15-beta.3 → 1.4.15-beta.5

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<ClickEventDetails>} - Success response
+     * @returns {Promise<ClickEventResponse>} - Success response
      * @name 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/).
+     * @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/).
      */
-    saveClickEvent({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ClickEventDetails>;
+    saveClickEvent({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ClickEventResponse>;
 }

package/sdk/application/Webhook/WebhookApplicationClient.js

@@ -1,3 +1,8 @@
+const {
+  FDKClientValidationError,
+  FDKResponseValidationError,
+} = require("../../common/FDKError");
+
 const ApplicationAPIClient = require("../ApplicationAPIClient");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
@@ -28,15 +33,23 @@ class Webhook {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<ClickEventDetails>} - Success response
+   * @returns {Promise<ClickEventResponse>} - Success response
    * @name 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/).
+   * @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/).
    */
   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/partner/FileStorage/FileStoragePartnerClient.d.ts

@@ -3,32 +3,12 @@ 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 {FileStoragePartnerValidator.StartUploadParam} 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.
+     * @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
      * @description: Uploads an arbitrarily sized buffer or blob.
      *
      * It has three Major Steps:
@@ -47,16 +27,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/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.FileUploadComplete>;
+    startUpload({ namespace, body, requestHeaders }?: FileStoragePartnerValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.StartResponse>;
     /**
-     * @param {FileStoragePartnerValidator.StartUploadParam} arg - Arg object.
+     * @param {FileStoragePartnerValidator.CompleteUploadParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
-     * @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.
+     * @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
      * @description: Uploads an arbitrarily sized buffer or blob.
      *
      * It has three Major Steps:
@@ -75,9 +55,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/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.FileUpload>;
+    completeUpload({ namespace, body, requestHeaders }?: FileStoragePartnerValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.CompleteResponse>;
     /**
      * @param {FileStoragePartnerValidator.BrowseParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -88,59 +68,5 @@ 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");