@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

package/sdk/platform/OAuthClient.js

@@ -49,11 +49,11 @@ class OAuthClient {
     if (this.refreshToken && this.useAutoRenewTimer) {
       this.retryOAuthToken(token.expires_in);
     }
-    Logger({ type: "INFO", message: "Token set." });
+    Logger({ level: "INFO", message: "Token set." });
   }
 
   retryOAuthToken(expires_in) {
-    Logger({ type: "INFO", message: "Retrying OAuth Token..." });
+    Logger({ level: "INFO", message: "Retrying OAuth Token..." });
     if (this.retryOAuthTokenTimer) {
       clearTimeout(this.retryOAuthTokenTimer);
     }
@@ -65,7 +65,7 @@ class OAuthClient {
   }
 
   startAuthorization(options) {
-    Logger({ type: "INFO", message: "Starting Authorization..." });
+    Logger({ level: "INFO", message: "Starting Authorization..." });
     let query = {
       client_id: this.config.apiKey,
       scope: options.scope.join(","),
@@ -86,7 +86,7 @@ class OAuthClient {
       signQuery: true,
     };
     signingOptions = sign(signingOptions);
-    Logger({ type: "INFO", message: "Authorization successful.!" });
+    Logger({ level: "INFO", message: "Authorization successful.!" });
 
     return `${this.config.domain}${signingOptions.path}`;
   }
@@ -116,7 +116,7 @@ class OAuthClient {
 
   async renewAccessToken(isOfflineToken = false) {
     try {
-      Logger({ type: "INFO", message: "Renewing Access token..." });
+      Logger({ level: "INFO", message: "Renewing Access token..." });
       let res;
       if (isOfflineToken) {
         let requestCacheKey = `${this.config.apiKey}:${this.config.companyId}`;
@@ -138,7 +138,7 @@ class OAuthClient {
       this.setToken(res);
       this.token_expires_at =
         new Date().getTime() + this.token_expires_in * 1000;
-      Logger({ type: "INFO", message: "Done." });
+      Logger({ level: "INFO", message: "Done." });
       return res;
     } catch (error) {
       if (error.isAxiosError) {
@@ -149,7 +149,7 @@ class OAuthClient {
   }
 
   async getAccesstokenObj({ grant_type, refresh_token, code }) {
-    Logger({ type: "INFO", message: "Processing Access token object..." });
+    Logger({ level: "INFO", message: "Processing Access token object..." });
     let reqData = {
       grant_type: grant_type,
     };
@@ -173,7 +173,7 @@ class OAuthClient {
         "Content-Type": "application/x-www-form-urlencoded",
       },
     };
-    Logger({ type: "INFO", message: "Done." });
+    Logger({ level: "INFO", message: "Done." });
     return fdkAxios.request(rawRequest);
   }
 

package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts

@@ -19,6 +19,7 @@ declare class Order {
      * @param {number} [arg.pageSize] -
      * @param {string} [arg.customerId] -
      * @param {boolean} [arg.isPrioritySort] -
+     * @returns {Promise<ShipmentInternalPlatformViewResponse>} - Success response
      * @summary:
      * @description:
      */
@@ -37,23 +38,25 @@ declare class Order {
         pageSize?: number;
         customerId?: string;
         isPrioritySort?: boolean;
-    }): Promise<any>;
+    }): Promise<ShipmentInternalPlatformViewResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.orderId -
+     * @returns {Promise<ShipmentDetailsResponse>} - Success response
      * @summary:
      * @description:
      */
     getAppOrderShipmentDetails({ orderId }?: {
         orderId: string;
-    }): Promise<any>;
+    }): Promise<ShipmentDetailsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.shipmentId -
+     * @returns {Promise<PlatformShipmentTrack>} - Success response
      * @summary: Track shipment
      * @description: Track Shipment by shipment id, for application based on application Id
      */
     trackPlatformShipment({ shipmentId }?: {
         shipmentId: string;
-    }): Promise<any>;
+    }): Promise<PlatformShipmentTrack>;
 }

package/sdk/platform/Order/OrderPlatformApplicationClient.js

@@ -2,6 +2,8 @@ const Paginator = require("../../common/Paginator");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const OrderValidator = require("./OrderPlatformApplicationValidator");
+const OrderModel = require("./OrderPlatformModel");
+const { Logger } = require("./../../common/Logger");
 
 class Order {
   constructor(config, applicationId) {
@@ -25,10 +27,11 @@ class Order {
    * @param {number} [arg.pageSize] -
    * @param {string} [arg.customerId] -
    * @param {boolean} [arg.isPrioritySort] -
+   * @returns {Promise<ShipmentInternalPlatformViewResponse>} - Success response
    * @summary:
    * @description:
    */
-  getApplicationShipments({
+  async getApplicationShipments({
     lane,
     searchType,
     searchId,
@@ -67,6 +70,36 @@ class Order {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = OrderValidator.getApplicationShipments().validate(
+      {
+        lane,
+        searchType,
+        searchId,
+        fromDate,
+        toDate,
+        dpIds,
+        orderingCompanyId,
+        stores,
+        salesChannel,
+        requestByExt,
+        pageNo,
+        pageSize,
+        customerId,
+        isPrioritySort,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getApplicationShipments",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["lane"] = lane;
     query_params["search_type"] = searchType;
@@ -83,22 +116,40 @@ class Order {
     query_params["customer_id"] = customerId;
     query_params["is_priority_sort"] = isPrioritySort;
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/orders/v1.0/company/${this.config.companyId}/application/${this.applicationId}/shipments/`,
       query_params,
       undefined
     );
+
+    const {
+      error: res_error,
+    } = OrderModel.ShipmentInternalPlatformViewResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getApplicationShipments",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.orderId -
+   * @returns {Promise<ShipmentDetailsResponse>} - Success response
    * @summary:
    * @description:
    */
-  getAppOrderShipmentDetails({ orderId } = {}) {
+  async getAppOrderShipmentDetails({ orderId } = {}) {
     const { error } = OrderValidator.getAppOrderShipmentDetails().validate(
       {
         orderId,
@@ -109,25 +160,61 @@ class Order {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = OrderValidator.getAppOrderShipmentDetails().validate(
+      {
+        orderId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message:
+          "Parameter Validation warrnings for getAppOrderShipmentDetails",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["order_id"] = orderId;
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/orders/v1.0/company/${this.config.companyId}/application/${this.applicationId}/order-details`,
       query_params,
       undefined
     );
+
+    const {
+      error: res_error,
+    } = OrderModel.ShipmentDetailsResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getAppOrderShipmentDetails",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.shipmentId -
+   * @returns {Promise<PlatformShipmentTrack>} - Success response
    * @summary: Track shipment
    * @description: Track Shipment by shipment id, for application based on application Id
    */
-  trackPlatformShipment({ shipmentId } = {}) {
+  async trackPlatformShipment({ shipmentId } = {}) {
     const { error } = OrderValidator.trackPlatformShipment().validate(
       {
         shipmentId,
@@ -138,15 +225,47 @@ class Order {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = OrderValidator.trackPlatformShipment().validate(
+      {
+        shipmentId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for trackPlatformShipment",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/orders/v1.0/company/${this.config.companyId}/application/${this.applicationId}/orders/shipments/${shipmentId}/track`,
       query_params,
       undefined
     );
+
+    const {
+      error: res_error,
+    } = OrderModel.PlatformShipmentTrack().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for trackPlatformShipment",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 }
 module.exports = Order;