@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

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,
@@ -43,11 +47,27 @@ class FileStorage {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = FileStorageValidator.startUpload().validate(
+      {
+        namespace,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (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/`,
@@ -55,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.
    *
@@ -81,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,
@@ -93,11 +131,27 @@ class FileStorage {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = FileStorageValidator.completeUpload().validate(
+      {
+        namespace,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (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/`,
@@ -105,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,
@@ -124,11 +196,26 @@ class FileStorage {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = FileStorageValidator.getSignUrls().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (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/`,
@@ -136,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,
@@ -157,12 +262,28 @@ class FileStorage {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = FileStorageValidator.copyFiles().validate(
+      {
+        body,
+        sync,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for copyFiles",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["sync"] = sync;
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/assets/v1.0/company/${this.config.companyId}/uploads/copy/`,
@@ -170,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,
@@ -191,12 +330,28 @@ 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;
 
     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/`,
@@ -204,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;
   }
 
   /**
@@ -235,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,
@@ -249,12 +422,27 @@ class FileStorage {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = FileStorageValidator.proxy().validate(
+      {
+        url,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for proxy",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["url"] = url;
 
     const xHeaders = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/assets/v1.0/company/${this.config.companyId}/proxy/`,
@@ -262,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;
   }
 }
 

package/sdk/platform/Inventory/InventoryPlatformClient.d.ts

@@ -6,92 +6,103 @@ declare class Inventory {
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] - Page Number
      * @param {number} [arg.pageSize] - Page Size
+     * @returns {Promise<ResponseEnvelopeListJobConfigRawDTO>} - Success response
      * @summary: Get Job Configs For A Company
      * @description: REST Endpoint that returns all job configs for a company
      */
     getJobsByCompany({ pageNo, pageSize }?: {
         pageNo?: number;
         pageSize?: number;
-    }): Promise<any>;
+    }): Promise<ResponseEnvelopeListJobConfigRawDTO>;
     /**
      * @param {Object} arg - Arg object.
      * @param {JobConfigDTO} arg.body
+     * @returns {Promise<ResponseEnvelopeString>} - Success response
      * @summary: Updates An Existing Job Config
      * @description: REST Endpoint that updates a job config
      */
     updateJob({ body }?: {
         body: JobConfigDTO;
-    }): Promise<any>;
+    }): Promise<ResponseEnvelopeString>;
     /**
      * @param {Object} arg - Arg object.
      * @param {JobConfigDTO} arg.body
+     * @returns {Promise<ResponseEnvelopeString>} - Success response
      * @summary: Creates A New Job Config
      * @description: REST Endpoint that creates a new job config
      */
     createJob({ body }?: {
         body: JobConfigDTO;
-    }): Promise<any>;
+    }): Promise<ResponseEnvelopeString>;
     /**
      * @param {Object} arg - Arg object.
      * @param {SuppressStorePayload} arg.body
+     * @returns {Promise<ResponseEnvelopeKafkaResponse>} - Success response
      * @summary: Get Slingshot Configuration Of  A Company
      * @description: REST Endpoint that returns all configuration detail of a company
      */
     suppressStores({ body }?: {
         body: SuppressStorePayload;
-    }): Promise<any>;
+    }): Promise<ResponseEnvelopeKafkaResponse>;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<ResponseEnvelopeListSlingshotConfigurationDetail>} -
+     *   Success response
      * @summary: Get Slingshot Configuration Of  A Company
      * @description: REST Endpoint that returns all configuration detail of a company
      */
-    getConfigByCompany({}?: any): Promise<any>;
+    getConfigByCompany({}?: any): Promise<ResponseEnvelopeListSlingshotConfigurationDetail>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} arg.jobId - Job Id
+     * @returns {Promise<ResponseEnvelopeListJobStepsDTO>} - Success response
      * @summary: Get Job Code Steps
      * @description: REST Endpoint that returns Inventory Job Steps
      */
     getJobSteps({ jobId }?: {
         jobId: number;
-    }): Promise<any>;
+    }): Promise<ResponseEnvelopeListJobStepsDTO>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.integrationId - Integration Id
      * @param {number} [arg.pageNo] - Page Number
      * @param {number} [arg.pageSize] - Page Size
+     * @returns {Promise<ResponseEnvelopeListJobConfigDTO>} - Success response
      * @summary: Get Job Configs By Company And Integration
      * @description: REST Endpoint that returns all job configs by company And integration
      */
-    getJobByCompanyAndIntegration({ integrationId, pageNo, pageSize }?: {
+    getJobByCompanyAndIntegration({ integrationId, pageNo, pageSize, }?: {
         integrationId: string;
         pageNo?: number;
         pageSize?: number;
-    }): Promise<any>;
+    }): Promise<ResponseEnvelopeListJobConfigDTO>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.integrationId - IntegrationId
+     * @returns {Promise<ResponseEnvelopeString>} - Success response
      * @summary: Disable Job Config
      * @description: REST Endpoint that disables Inventory Job Config
      */
     disable({ integrationId }?: {
         integrationId: string;
-    }): Promise<any>;
+    }): Promise<ResponseEnvelopeString>;
     /**
      * @param {Object} arg - Arg object.
+     * @returns {Promise<ResponseEnvelopeJobConfigDTO>} - Success response
      * @summary: Get Job Configs Defaults
      * @description: REST Endpoint that returns default fields job configs by company And integration
      */
-    getJobConfigDefaults({}?: any): Promise<any>;
+    getJobConfigDefaults({}?: any): Promise<ResponseEnvelopeJobConfigDTO>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.code - Job Code
+     * @returns {Promise<ResponseEnvelopeJobConfigDTO>} - Success response
      * @summary: Get Job Config By Code
      * @description: REST Endpoint that returns job config by code
      */
     getJobByCode({ code }?: {
         code: string;
-    }): Promise<any>;
+    }): Promise<ResponseEnvelopeJobConfigDTO>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.code - Code
@@ -99,6 +110,7 @@ declare class Inventory {
      * @param {number} [arg.pageSize] - Page Size
      * @param {string} [arg.status] - Status
      * @param {string} [arg.date] - From Date
+     * @returns {Promise<ResponseEnvelopeJobMetricsDto>} - Success response
      * @summary: Get Job Metrics
      * @description: REST Endpoint that returns Inventory Run History For A Job Code
      */
@@ -108,18 +120,19 @@ declare class Inventory {
         pageSize?: number;
         status?: string;
         date?: string;
-    }): Promise<any>;
+    }): Promise<ResponseEnvelopeJobMetricsDto>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.integrationId - Integration Id
      * @param {number} [arg.pageNo] - Page Number
      * @param {number} [arg.pageSize] - Page Size
+     * @returns {Promise<ResponseEnvelopeListJobConfigListDTO>} - Success response
      * @summary: Get Job Codes By Company And Integration
      * @description: REST Endpoint that returns all job codes by company And integration
      */
-    getJobCodesByCompanyAndIntegration({ integrationId, pageNo, pageSize }?: {
+    getJobCodesByCompanyAndIntegration({ integrationId, pageNo, pageSize, }?: {
         integrationId: string;
         pageNo?: number;
         pageSize?: number;
-    }): Promise<any>;
+    }): Promise<ResponseEnvelopeListJobConfigListDTO>;
 }