@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

package/sdk/application/Order/OrderApplicationClient.js

@@ -3,6 +3,8 @@ const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const OrderValidator = require("./OrderApplicationValidator");
+const OrderModel = require("./OrderApplicationModel");
+const { Logger } = require("./../../common/Logger");
 
 class Order {
   constructor(_conf) {
@@ -64,7 +66,14 @@ class Order {
    * @summary: Get all orders
    * @description: Use this API to retrieve all the orders.
    */
-  getOrders({ status, pageNo, pageSize, fromDate, toDate, customMeta } = {}) {
+  async getOrders({
+    status,
+    pageNo,
+    pageSize,
+    fromDate,
+    toDate,
+    customMeta,
+  } = {}) {
     const { error } = OrderValidator.getOrders().validate(
       { status, pageNo, pageSize, fromDate, toDate, customMeta },
       { abortEarly: false, allowUnknown: true }
@@ -72,6 +81,20 @@ class Order {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = OrderValidator.getOrders().validate(
+      { status, pageNo, pageSize, fromDate, toDate, customMeta },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getOrders",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["status"] = status;
     query_params["page_no"] = pageNo;
@@ -82,7 +105,7 @@ class Order {
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -93,6 +116,21 @@ class Order {
       undefined,
       xHeaders
     );
+
+    const { error: res_error } = OrderModel.OrderList().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getOrders",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -103,7 +141,7 @@ class Order {
    * @summary: Get details of an order
    * @description: Use this API to retrieve order details such as tracking details, shipment, store information using Fynd Order ID.
    */
-  getOrderById({ orderId } = {}) {
+  async getOrderById({ orderId } = {}) {
     const { error } = OrderValidator.getOrderById().validate(
       { orderId },
       { abortEarly: false, allowUnknown: true }
@@ -111,11 +149,25 @@ class Order {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = OrderValidator.getOrderById().validate(
+      { orderId },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getOrderById",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -126,6 +178,21 @@ class Order {
       undefined,
       xHeaders
     );
+
+    const { error: res_error } = OrderModel.OrderById().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getOrderById",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -136,7 +203,7 @@ class Order {
    * @summary: Get POS Order
    * @description: Use this API to retrieve a POS order and all its details such as tracking details, shipment, store information using Fynd Order ID.
    */
-  getPosOrderById({ orderId } = {}) {
+  async getPosOrderById({ orderId } = {}) {
     const { error } = OrderValidator.getPosOrderById().validate(
       { orderId },
       { abortEarly: false, allowUnknown: true }
@@ -144,11 +211,25 @@ class Order {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = OrderValidator.getPosOrderById().validate(
+      { orderId },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getPosOrderById",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -159,6 +240,21 @@ class Order {
       undefined,
       xHeaders
     );
+
+    const { error: res_error } = OrderModel.OrderList().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getPosOrderById",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -170,7 +266,7 @@ class Order {
    * @summary: Get details of a shipment
    * @description: Use this API to retrieve shipment details such as price breakup, tracking details, store information, etc. using Shipment ID.
    */
-  getShipmentById({ shipmentId } = {}) {
+  async getShipmentById({ shipmentId } = {}) {
     const { error } = OrderValidator.getShipmentById().validate(
       { shipmentId },
       { abortEarly: false, allowUnknown: true }
@@ -178,11 +274,25 @@ class Order {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = OrderValidator.getShipmentById().validate(
+      { shipmentId },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getShipmentById",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -193,6 +303,21 @@ class Order {
       undefined,
       xHeaders
     );
+
+    const { error: res_error } = OrderModel.ShipmentById().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getShipmentById",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -202,7 +327,7 @@ class Order {
    * @summary: Get Invoice of a shipment
    * @description: Use this API to retrieve shipment invoice.
    */
-  getInvoiceByShipmentId({ shipmentId } = {}) {
+  async getInvoiceByShipmentId({ shipmentId } = {}) {
     const { error } = OrderValidator.getInvoiceByShipmentId().validate(
       { shipmentId },
       { abortEarly: false, allowUnknown: true }
@@ -210,11 +335,27 @@ class Order {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = OrderValidator.getInvoiceByShipmentId().validate(
+      { shipmentId },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getInvoiceByShipmentId",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -225,6 +366,23 @@ class Order {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = OrderModel.ResponseGetInvoiceShipment().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getInvoiceByShipmentId",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -236,7 +394,7 @@ class Order {
    * @summary: Track shipment
    * @description: Track Shipment by shipment id, for application based on application Id
    */
-  trackShipment({ shipmentId } = {}) {
+  async trackShipment({ shipmentId } = {}) {
     const { error } = OrderValidator.trackShipment().validate(
       { shipmentId },
       { abortEarly: false, allowUnknown: true }
@@ -244,11 +402,25 @@ class Order {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = OrderValidator.trackShipment().validate(
+      { shipmentId },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for trackShipment",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -259,6 +431,21 @@ class Order {
       undefined,
       xHeaders
     );
+
+    const { error: res_error } = OrderModel.ShipmentTrack().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for trackShipment",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -272,7 +459,7 @@ class Order {
    * @summary: Get Customer Details by Shipment Id
    * @description: Use this API to retrieve customer details such as mobileno using Shipment ID.
    */
-  getCustomerDetailsByShipmentId({ orderId, shipmentId } = {}) {
+  async getCustomerDetailsByShipmentId({ orderId, shipmentId } = {}) {
     const { error } = OrderValidator.getCustomerDetailsByShipmentId().validate(
       { orderId, shipmentId },
       { abortEarly: false, allowUnknown: true }
@@ -280,11 +467,28 @@ class Order {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = OrderValidator.getCustomerDetailsByShipmentId().validate(
+      { orderId, shipmentId },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message:
+          "Parameter Validation warrnings for getCustomerDetailsByShipmentId",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -295,6 +499,24 @@ class Order {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = OrderModel.CustomerDetailsResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message:
+          "Response Validation Warnnings for getCustomerDetailsByShipmentId",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -308,7 +530,7 @@ class Order {
    * @summary: Send and Resend Otp code to Order-Shipment customer
    * @description: Use this API to send OTP to the customer of the mapped Shipment.
    */
-  sendOtpToShipmentCustomer({ orderId, shipmentId } = {}) {
+  async sendOtpToShipmentCustomer({ orderId, shipmentId } = {}) {
     const { error } = OrderValidator.sendOtpToShipmentCustomer().validate(
       { orderId, shipmentId },
       { abortEarly: false, allowUnknown: true }
@@ -316,11 +538,27 @@ class Order {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = OrderValidator.sendOtpToShipmentCustomer().validate(
+      { orderId, shipmentId },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for sendOtpToShipmentCustomer",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "post",
       constructUrl({
@@ -331,6 +569,23 @@ class Order {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = OrderModel.SendOtpToCustomerResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for sendOtpToShipmentCustomer",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -345,7 +600,7 @@ class Order {
    * @summary: Verify Otp code
    * @description: Use this API to verify OTP and create a session token with custom payload.
    */
-  verifyOtpShipmentCustomer({ orderId, shipmentId, body } = {}) {
+  async verifyOtpShipmentCustomer({ orderId, shipmentId, body } = {}) {
     const { error } = OrderValidator.verifyOtpShipmentCustomer().validate(
       { orderId, shipmentId, body },
       { abortEarly: false, allowUnknown: true }
@@ -353,11 +608,27 @@ class Order {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = OrderValidator.verifyOtpShipmentCustomer().validate(
+      { orderId, shipmentId, body },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for verifyOtpShipmentCustomer",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "post",
       constructUrl({
@@ -368,6 +639,23 @@ class Order {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = OrderModel.VerifyOtpResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for verifyOtpShipmentCustomer",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -381,7 +669,7 @@ class Order {
    * @summary: Get reasons behind full or partial cancellation of a shipment
    * @description: Use this API to retrieve the issues that led to the cancellation of bags within a shipment.
    */
-  getShipmentBagReasons({ shipmentId, bagId } = {}) {
+  async getShipmentBagReasons({ shipmentId, bagId } = {}) {
     const { error } = OrderValidator.getShipmentBagReasons().validate(
       { shipmentId, bagId },
       { abortEarly: false, allowUnknown: true }
@@ -389,11 +677,25 @@ class Order {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = OrderValidator.getShipmentBagReasons().validate(
+      { shipmentId, bagId },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getShipmentBagReasons",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -404,6 +706,23 @@ class Order {
       undefined,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = OrderModel.ShipmentBagReasons().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getShipmentBagReasons",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -415,7 +734,7 @@ class Order {
    * @summary: Get reasons behind full or partial cancellation of a shipment
    * @description: Use this API to retrieve the issues that led to the cancellation of bags within a shipment.
    */
-  getShipmentReasons({ shipmentId } = {}) {
+  async getShipmentReasons({ shipmentId } = {}) {
     const { error } = OrderValidator.getShipmentReasons().validate(
       { shipmentId },
       { abortEarly: false, allowUnknown: true }
@@ -423,11 +742,25 @@ class Order {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = OrderValidator.getShipmentReasons().validate(
+      { shipmentId },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getShipmentReasons",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -438,6 +771,21 @@ class Order {
       undefined,
       xHeaders
     );
+
+    const { error: res_error } = OrderModel.ShipmentReasons().validate(
+      response,
+      { abortEarly: false, allowUnknown: false }
+    );
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getShipmentReasons",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -450,7 +798,7 @@ class Order {
    * @summary: Update the shipment status
    * @description: Use this API to update the status of a shipment using its shipment ID.
    */
-  updateShipmentStatus({ shipmentId, body } = {}) {
+  async updateShipmentStatus({ shipmentId, body } = {}) {
     const { error } = OrderValidator.updateShipmentStatus().validate(
       { shipmentId, body },
       { abortEarly: false, allowUnknown: true }
@@ -458,11 +806,25 @@ class Order {
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = OrderValidator.updateShipmentStatus().validate(
+      { shipmentId, body },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for updateShipmentStatus",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "put",
       constructUrl({
@@ -473,6 +835,23 @@ class Order {
       body,
       xHeaders
     );
+
+    const {
+      error: res_error,
+    } = OrderModel.ShipmentApplicationStatusResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for updateShipmentStatus",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 }