@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts

@@ -7,6 +7,7 @@ declare class FileStorage {
      * @param {Object} arg - Arg object.
      * @param {string} arg.namespace - Bucket name
      * @param {StartRequest} arg.body
+     * @returns {Promise<StartResponse>} - Success response
      * @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.
      *
@@ -30,11 +31,12 @@ declare class FileStorage {
     appStartUpload({ namespace, body }?: {
         namespace: string;
         body: StartRequest;
-    }): Promise<any>;
+    }): Promise<StartResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.namespace - Bucket name
      * @param {StartResponse} arg.body
+     * @returns {Promise<CompleteResponse>} - Success response
      * @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.
      *
@@ -58,29 +60,31 @@ declare class FileStorage {
     appCompleteUpload({ namespace, body }?: {
         namespace: string;
         body: StartResponse;
-    }): Promise<any>;
+    }): Promise<CompleteResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {boolean} [arg.sync] - Sync
      * @param {BulkRequest} arg.body
+     * @returns {Promise<BulkUploadResponse>} - Success response
      * @summary: Copy Files
      * @description: Copy Files
      */
     appCopyFiles({ body, sync }?: {
         sync?: boolean;
         body: BulkRequest;
-    }): Promise<any>;
+    }): Promise<BulkUploadResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.namespace - Bucket name
      * @param {number} [arg.pageNo] - Page no
+     * @returns {Promise<BrowseResponse>} - Success response
      * @summary: Browse Files
      * @description: Browse Files
      */
     browse({ namespace, pageNo }?: {
         namespace: string;
         pageNo?: number;
-    }): Promise<any>;
+    }): Promise<BrowseResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.namespace - Bucket name

package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js

@@ -2,6 +2,8 @@ const Paginator = require("../../common/Paginator");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const FileStorageValidator = require("./FileStoragePlatformApplicationValidator");
+const FileStorageModel = require("./FileStoragePlatformModel");
+const { Logger } = require("./../../common/Logger");
 
 class FileStorage {
   constructor(config, applicationId) {
@@ -13,6 +15,7 @@ class FileStorage {
    * @param {Object} arg - Arg object.
    * @param {string} arg.namespace - Bucket name
    * @param {StartRequest} arg.body
+   * @returns {Promise<StartResponse>} - Success response
    * @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.
    *
@@ -33,7 +36,7 @@ class FileStorage {
    * After successfully upload, call `appCompleteUpload` api to complete the upload process.
    * This operation will return the url for the uploaded file.
    */
-  appStartUpload({ namespace, body } = {}) {
+  async appStartUpload({ namespace, body } = {}) {
     const { error } = FileStorageValidator.appStartUpload().validate(
       {
         namespace,
@@ -45,21 +48,55 @@ class FileStorage {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = FileStorageValidator.appStartUpload().validate(
+      {
+        namespace,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for appStartUpload",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/namespaces/${namespace}/upload/start/`,
       query_params,
       body
     );
+
+    const {
+      error: res_error,
+    } = FileStorageModel.StartResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for appStartUpload",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.namespace - Bucket name
    * @param {StartResponse} arg.body
+   * @returns {Promise<CompleteResponse>} - Success response
    * @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.
    *
@@ -80,7 +117,7 @@ class FileStorage {
    * After successfully upload, call `appCompleteUpload` api to complete the upload process.
    * This operation will return the url for the uploaded file.
    */
-  appCompleteUpload({ namespace, body } = {}) {
+  async appCompleteUpload({ namespace, body } = {}) {
     const { error } = FileStorageValidator.appCompleteUpload().validate(
       {
         namespace,
@@ -92,25 +129,61 @@ class FileStorage {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = FileStorageValidator.appCompleteUpload().validate(
+      {
+        namespace,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for appCompleteUpload",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/namespaces/${namespace}/upload/complete/`,
       query_params,
       body
     );
+
+    const {
+      error: res_error,
+    } = FileStorageModel.CompleteResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for appCompleteUpload",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {boolean} [arg.sync] - Sync
    * @param {BulkRequest} arg.body
+   * @returns {Promise<BulkUploadResponse>} - Success response
    * @summary: Copy Files
    * @description: Copy Files
    */
-  appCopyFiles({ body, sync } = {}) {
+  async appCopyFiles({ body, sync } = {}) {
     const { error } = FileStorageValidator.appCopyFiles().validate(
       {
         body,
@@ -122,26 +195,60 @@ class FileStorage {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = FileStorageValidator.appCopyFiles().validate(
+      {
+        body,
+        sync,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for appCopyFiles",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["sync"] = sync;
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/uploads/copy/`,
       query_params,
       body
     );
+
+    const {
+      error: res_error,
+    } = FileStorageModel.BulkUploadResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for appCopyFiles",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.namespace - Bucket name
    * @param {number} [arg.pageNo] - Page no
+   * @returns {Promise<BrowseResponse>} - Success response
    * @summary: Browse Files
    * @description: Browse Files
    */
-  browse({ namespace, pageNo } = {}) {
+  async browse({ namespace, pageNo } = {}) {
     const { error } = FileStorageValidator.browse().validate(
       {
         namespace,
@@ -153,16 +260,49 @@ class FileStorage {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = FileStorageValidator.browse().validate(
+      {
+        namespace,
+        pageNo,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for browse",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["page_no"] = pageNo;
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/namespaces/${namespace}/browse/`,
       query_params,
       undefined
     );
+
+    const {
+      error: res_error,
+    } = FileStorageModel.BrowseResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for browse",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**

package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts

@@ -6,6 +6,7 @@ declare class FileStorage {
      * @param {Object} arg - Arg object.
      * @param {string} arg.namespace - Bucket name
      * @param {StartRequest} arg.body
+     * @returns {Promise<StartResponse>} - Success response
      * @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.
      *
@@ -29,11 +30,12 @@ declare class FileStorage {
     startUpload({ namespace, body }?: {
         namespace: string;
         body: StartRequest;
-    }): Promise<any>;
+    }): Promise<StartResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.namespace - Bucket name
      * @param {StartResponse} arg.body
+     * @returns {Promise<CompleteResponse>} - Success response
      * @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.
      *
@@ -57,38 +59,41 @@ declare class FileStorage {
     completeUpload({ namespace, body }?: {
         namespace: string;
         body: StartResponse;
-    }): Promise<any>;
+    }): Promise<CompleteResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {SignUrlRequest} arg.body
+     * @returns {Promise<SignUrlResponse>} - Success response
      * @summary: Gives signed urls to access private files
      * @description: Describe here
      */
     getSignUrls({ body }?: {
         body: SignUrlRequest;
-    }): Promise<any>;
+    }): Promise<SignUrlResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {boolean} [arg.sync] - Sync
      * @param {BulkRequest} arg.body
+     * @returns {Promise<BulkUploadResponse>} - Success response
      * @summary: Copy Files
      * @description: Copy Files
      */
     copyFiles({ body, sync }?: {
         sync?: boolean;
         body: BulkRequest;
-    }): Promise<any>;
+    }): Promise<BulkUploadResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.namespace - Bucket name
      * @param {number} [arg.pageNo] - Page no
+     * @returns {Promise<BrowseResponse>} - Success response
      * @summary: Browse Files
      * @description: Browse Files
      */
     browse({ namespace, pageNo }?: {
         namespace: string;
         pageNo?: number;
-    }): Promise<any>;
+    }): Promise<BrowseResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.namespace - Bucket name
@@ -101,12 +106,13 @@ declare class FileStorage {
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.url - Url
+     * @returns {Promise<string>} - Success response
      * @summary: Proxy
      * @description: Proxy
      */
     proxy({ url }?: {
         url: string;
-    }): Promise<any>;
+    }): Promise<string>;
     /**
      * @param data
      * @param {string} file_name