@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

package/sdk/application/Logistic/LogisticApplicationClient.js

@@ -2,8 +2,8 @@ const ApplicationAPIClient = require("../ApplicationAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
-const LogisticValidator = require("./LogisticApplicationValidator");
-const LogisticModel = require("./LogisticApplicationModel");
+const LogisticApplicationValidator = require("./LogisticApplicationValidator");
+const LogisticApplicationModel = require("./LogisticApplicationModel");
 const { Logger } = require("./../../common/Logger");
 const Joi = require("joi");
 
@@ -35,13 +35,19 @@ class Logistic {
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @returns {Promise<CountryListResponse>} - Success response
+   * @param {LogisticApplicationValidator.GetAllCountriesParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<LogisticApplicationModel.CountryListResponse>} - Success response
+   * @name getAllCountries
    * @summary: Get Country List
-   * @description: Get all countries
+   * @description: Get all countries - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getAllCountries/).
    */
-  async getAllCountries({} = {}) {
-    const { error } = LogisticValidator.getAllCountries().validate(
+  async getAllCountries(
+    { requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = LogisticApplicationValidator.getAllCountries().validate(
       {},
       { abortEarly: false, allowUnknown: true }
     );
@@ -50,16 +56,17 @@ class Logistic {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = LogisticValidator.getAllCountries().validate(
+    const {
+      error: warrning,
+    } = LogisticApplicationValidator.getAllCountries().validate(
       {},
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getAllCountries",
+        message: `Parameter Validation warrnings for application > Logistic > getAllCountries \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -75,12 +82,18 @@ class Logistic {
       }),
       query_params,
       undefined,
-      xHeaders
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = LogisticModel.CountryListResponse().validate(response, {
+    } = LogisticApplicationModel.CountryListResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -88,23 +101,30 @@ class Logistic {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getAllCountries",
+        message: `Response Validation Warnnings for application > Logistic > getAllCountries \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {ReAssignStoreRequest} arg.body
-   * @returns {Promise<ReAssignStoreResponse>} - Success response
+   * @param {LogisticApplicationValidator.GetOptimalLocationsParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<LogisticApplicationModel.ReAssignStoreResponse>} -
+   *   Success response
+   * @name getOptimalLocations
    * @summary: GET zone from the Pincode.
-   * @description: This API returns zone from the Pincode View.
+   * @description: This API returns zone from the Pincode View. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getOptimalLocations/).
    */
-  async getOptimalLocations({ body } = {}) {
-    const { error } = LogisticValidator.getOptimalLocations().validate(
+  async getOptimalLocations(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = LogisticApplicationValidator.getOptimalLocations().validate(
       { body },
       { abortEarly: false, allowUnknown: true }
     );
@@ -115,16 +135,15 @@ class Logistic {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = LogisticValidator.getOptimalLocations().validate(
+    } = LogisticApplicationValidator.getOptimalLocations().validate(
       { body },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getOptimalLocations",
+        message: `Parameter Validation warrnings for application > Logistic > getOptimalLocations \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -140,37 +159,46 @@ class Logistic {
       }),
       query_params,
       body,
-      xHeaders
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = LogisticModel.ReAssignStoreResponse().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = LogisticApplicationModel.ReAssignStoreResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getOptimalLocations",
+        message: `Response Validation Warnnings for application > Logistic > getOptimalLocations \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.pincode - A `pincode` contains a specific address of
-   *   a location.
-   * @returns {Promise<PincodeApiResponse>} - Success response
+   * @param {LogisticApplicationValidator.GetPincodeCityParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<LogisticApplicationModel.PincodeApiResponse>} - Success response
+   * @name getPincodeCity
    * @summary: Get Pincode API
-   * @description: Get pincode data
+   * @description: Get pincode data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeCity/).
    */
-  async getPincodeCity({ pincode } = {}) {
-    const { error } = LogisticValidator.getPincodeCity().validate(
+  async getPincodeCity(
+    { pincode, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = LogisticApplicationValidator.getPincodeCity().validate(
       { pincode },
       { abortEarly: false, allowUnknown: true }
     );
@@ -179,16 +207,17 @@ class Logistic {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = LogisticValidator.getPincodeCity().validate(
+    const {
+      error: warrning,
+    } = LogisticApplicationValidator.getPincodeCity().validate(
       { pincode },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getPincodeCity",
+        message: `Parameter Validation warrnings for application > Logistic > getPincodeCity \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -204,12 +233,18 @@ class Logistic {
       }),
       query_params,
       undefined,
-      xHeaders
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = LogisticModel.PincodeApiResponse().validate(response, {
+    } = LogisticApplicationModel.PincodeApiResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -217,23 +252,29 @@ class Logistic {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getPincodeCity",
+        message: `Response Validation Warnnings for application > Logistic > getPincodeCity \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {GetZoneFromPincodeViewRequest} arg.body
-   * @returns {Promise<GetZoneFromPincodeViewResponse>} - Success response
+   * @param {LogisticApplicationValidator.GetPincodeZonesParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<LogisticApplicationModel.GetZoneFromPincodeViewResponse>}
+   *   - Success response
+   *
+   * @name getPincodeZones
    * @summary: GET zone from the Pincode.
-   * @description: This API returns zone from the Pincode View.
+   * @description: This API returns zone from the Pincode View. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
    */
-  async getPincodeZones({ body } = {}) {
-    const { error } = LogisticValidator.getPincodeZones().validate(
+  async getPincodeZones(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = LogisticApplicationValidator.getPincodeZones().validate(
       { body },
       { abortEarly: false, allowUnknown: true }
     );
@@ -242,16 +283,17 @@ class Logistic {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = LogisticValidator.getPincodeZones().validate(
+    const {
+      error: warrning,
+    } = LogisticApplicationValidator.getPincodeZones().validate(
       { body },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getPincodeZones",
+        message: `Parameter Validation warrnings for application > Logistic > getPincodeZones \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -267,36 +309,46 @@ class Logistic {
       }),
       query_params,
       body,
-      xHeaders
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = LogisticModel.GetZoneFromPincodeViewResponse().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = LogisticApplicationModel.GetZoneFromPincodeViewResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getPincodeZones",
+        message: `Response Validation Warnnings for application > Logistic > getPincodeZones \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {TATViewRequest} arg.body
-   * @returns {Promise<TATViewResponse>} - Success response
+   * @param {LogisticApplicationValidator.GetTatProductParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<LogisticApplicationModel.TATViewResponse>} - Success response
+   * @name getTatProduct
    * @summary: Get TAT API
-   * @description: Get TAT data
+   * @description: Get TAT data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getTatProduct/).
    */
-  async getTatProduct({ body } = {}) {
-    const { error } = LogisticValidator.getTatProduct().validate(
+  async getTatProduct(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = LogisticApplicationValidator.getTatProduct().validate(
       { body },
       { abortEarly: false, allowUnknown: true }
     );
@@ -305,16 +357,17 @@ class Logistic {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = LogisticValidator.getTatProduct().validate(
+    const {
+      error: warrning,
+    } = LogisticApplicationValidator.getTatProduct().validate(
       { body },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getTatProduct",
+        message: `Parameter Validation warrnings for application > Logistic > getTatProduct \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -330,12 +383,18 @@ class Logistic {
       }),
       query_params,
       body,
-      xHeaders
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = LogisticModel.TATViewResponse().validate(response, {
+    } = LogisticApplicationModel.TATViewResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -343,9 +402,8 @@ class Logistic {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getTatProduct",
+        message: `Response Validation Warnnings for application > Logistic > getTatProduct \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;