@gofynd/fdk-client-javascript 1.0.1 → 1.0.2

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,
@@ -54,25 +57,46 @@ class FileStorage {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for appStartUpload");
-      console.log(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.
    *
@@ -93,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,
@@ -116,29 +140,50 @@ class FileStorage {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for appCompleteUpload");
-      console.log(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,
@@ -159,30 +204,51 @@ class FileStorage {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for appCopyFiles");
-      console.log(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,
@@ -203,20 +269,40 @@ class FileStorage {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for browse");
-      console.log(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

package/sdk/platform/FileStorage/FileStoragePlatformClient.js

@@ -2,6 +2,9 @@ const Paginator = require("../../common/Paginator");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const FileStorageValidator = require("./FileStoragePlatformValidator");
+const FileStorageModel = require("./FileStoragePlatformModel");
+const { Logger } = require("./../../common/Logger");
+
 class FileStorage {
   constructor(config) {
     this.config = config;
@@ -11,6 +14,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.
    *
@@ -31,7 +35,7 @@ class FileStorage {
    * After successfully upload, call `completeUpload` api to complete the upload process.
    * This operation will return the url for the uploaded file.
    */
-  startUpload({ namespace, body } = {}) {
+  async startUpload({ namespace, body } = {}) {
     const { error } = FileStorageValidator.startUpload().validate(
       {
         namespace,
@@ -52,15 +56,18 @@ class FileStorage {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for startUpload");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for startUpload",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/assets/v1.0/company/${this.config.companyId}/namespaces/${namespace}/upload/start/`,
@@ -68,12 +75,30 @@ class FileStorage {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = FileStorageModel.StartResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for startUpload",
+      });
+      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.
    *
@@ -94,7 +119,7 @@ class FileStorage {
    * After successfully upload, call `completeUpload` api to complete the upload process.
    * This operation will return the url for the uploaded file.
    */
-  completeUpload({ namespace, body } = {}) {
+  async completeUpload({ namespace, body } = {}) {
     const { error } = FileStorageValidator.completeUpload().validate(
       {
         namespace,
@@ -115,15 +140,18 @@ class FileStorage {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for completeUpload");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for completeUpload",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/assets/v1.0/company/${this.config.companyId}/namespaces/${namespace}/upload/complete/`,
@@ -131,15 +159,33 @@ class FileStorage {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = FileStorageModel.CompleteResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for completeUpload",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @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 } = {}) {
+  async getSignUrls({ body } = {}) {
     const { error } = FileStorageValidator.getSignUrls().validate(
       {
         body,
@@ -158,15 +204,18 @@ class FileStorage {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getSignUrls");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getSignUrls",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/assets/v1.0/company/${this.config.companyId}/sign-urls/`,
@@ -174,16 +223,34 @@ class FileStorage {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = FileStorageModel.SignUrlResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getSignUrls",
+      });
+      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
    */
-  copyFiles({ body, sync } = {}) {
+  async copyFiles({ body, sync } = {}) {
     const { error } = FileStorageValidator.copyFiles().validate(
       {
         body,
@@ -204,8 +271,11 @@ class FileStorage {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for copyFiles");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for copyFiles",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -213,7 +283,7 @@ class FileStorage {
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/assets/v1.0/company/${this.config.companyId}/uploads/copy/`,
@@ -221,16 +291,34 @@ class FileStorage {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = FileStorageModel.BulkUploadResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for copyFiles",
+      });
+      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,
@@ -251,8 +339,11 @@ class FileStorage {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for browse");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for browse",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -260,7 +351,7 @@ class FileStorage {
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/assets/v1.0/company/${this.config.companyId}/namespaces/${namespace}/browse/`,
@@ -268,6 +359,23 @@ class FileStorage {
       undefined,
       xHeaders
     );
+
+    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;
   }
 
   /**
@@ -299,10 +407,11 @@ class FileStorage {
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.url - Url
+   * @returns {Promise<string>} - Success response
    * @summary: Proxy
    * @description: Proxy
    */
-  proxy({ url } = {}) {
+  async proxy({ url } = {}) {
     const { error } = FileStorageValidator.proxy().validate(
       {
         url,
@@ -321,8 +430,11 @@ class FileStorage {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for proxy");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for proxy",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -330,7 +442,7 @@ class FileStorage {
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/assets/v1.0/company/${this.config.companyId}/proxy/`,
@@ -338,6 +450,20 @@ class FileStorage {
       undefined,
       xHeaders
     );
+
+    const { error: res_error } = Joi.string()
+      .allow("")
+      .validate(response, { abortEarly: false, allowUnknown: false });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for proxy",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 }