@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/application/Rewards/RewardsApplicationClient.js

@@ -2,8 +2,8 @@ const ApplicationAPIClient = require("../ApplicationAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
-const RewardsValidator = require("./RewardsApplicationValidator");
-const RewardsModel = require("./RewardsApplicationModel");
+const RewardsApplicationValidator = require("./RewardsApplicationValidator");
+const RewardsApplicationModel = require("./RewardsApplicationModel");
 const { Logger } = require("./../../common/Logger");
 const Joi = require("joi");
 
@@ -41,14 +41,16 @@ class Rewards {
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {CatalogueOrderRequest} arg.body
-   * @returns {Promise<CatalogueOrderResponse>} - Success response
+   * @param {RewardsApplicationValidator.CatalogueOrderParam} arg - Arg object.
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<RewardsApplicationModel.CatalogueOrderResponse>} -
+   *   Success response
+   * @name catalogueOrder
    * @summary: Get all transactions of reward points
-   * @description: Use this API to evaluate the amount of reward points that could be earned on any catalogue product.
+   * @description: Use this API to evaluate the amount of reward points that could be earned on any catalogue product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/catalogueOrder/).
    */
-  async catalogueOrder({ body } = {}) {
-    const { error } = RewardsValidator.catalogueOrder().validate(
+  async catalogueOrder({ body } = {}, { headers } = { headers: false }) {
+    const { error } = RewardsApplicationValidator.catalogueOrder().validate(
       { body },
       { abortEarly: false, allowUnknown: true }
     );
@@ -57,16 +59,17 @@ class Rewards {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = RewardsValidator.catalogueOrder().validate(
+    const {
+      error: warrning,
+    } = RewardsApplicationValidator.catalogueOrder().validate(
       { body },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for catalogueOrder",
+        message: `Parameter Validation warrnings for application > Rewards > catalogueOrder \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -82,36 +85,42 @@ class Rewards {
       }),
       query_params,
       body,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = RewardsModel.CatalogueOrderResponse().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = RewardsApplicationModel.CatalogueOrderResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for catalogueOrder",
+        message: `Response Validation Warnnings for application > Rewards > catalogueOrder \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.name - The name given to the offer.
-   * @returns {Promise<Offer>} - Success response
+   * @param {RewardsApplicationValidator.GetOfferByNameParam} arg - Arg object.
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<RewardsApplicationModel.Offer>} - Success response
+   * @name getOfferByName
    * @summary: Get offer by name
-   * @description: Use this API to get fetch the specific offer details and configuration by the name of the offer.
+   * @description: Use this API to get fetch the specific offer details and configuration by the name of the offer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getOfferByName/).
    */
-  async getOfferByName({ name } = {}) {
-    const { error } = RewardsValidator.getOfferByName().validate(
+  async getOfferByName({ name } = {}, { headers } = { headers: false }) {
+    const { error } = RewardsApplicationValidator.getOfferByName().validate(
       { name },
       { abortEarly: false, allowUnknown: true }
     );
@@ -120,16 +129,17 @@ class Rewards {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = RewardsValidator.getOfferByName().validate(
+    const {
+      error: warrning,
+    } = RewardsApplicationValidator.getOfferByName().validate(
       { name },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getOfferByName",
+        message: `Parameter Validation warrnings for application > Rewards > getOfferByName \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -145,10 +155,18 @@ class Rewards {
       }),
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
-    const { error: res_error } = RewardsModel.Offer().validate(response, {
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = RewardsApplicationModel.Offer().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -156,23 +174,24 @@ class Rewards {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getOfferByName",
+        message: `Response Validation Warnnings for application > Rewards > getOfferByName \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {OrderDiscountRequest} arg.body
-   * @returns {Promise<OrderDiscountResponse>} - Success response
+   * @param {RewardsApplicationValidator.GetOrderDiscountParam} arg - Arg object.
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<RewardsApplicationModel.OrderDiscountResponse>} -
+   *   Success response
+   * @name getOrderDiscount
    * @summary: Calculates the discount on order-amount
-   * @description: Use this API to calculate the discount on the order amount, based on all the amount range configured in Order Discount offer.
+   * @description: Use this API to calculate the discount on the order amount, based on all the amount range configured in Order Discount offer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getOrderDiscount/).
    */
-  async getOrderDiscount({ body } = {}) {
-    const { error } = RewardsValidator.getOrderDiscount().validate(
+  async getOrderDiscount({ body } = {}, { headers } = { headers: false }) {
+    const { error } = RewardsApplicationValidator.getOrderDiscount().validate(
       { body },
       { abortEarly: false, allowUnknown: true }
     );
@@ -181,16 +200,17 @@ class Rewards {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = RewardsValidator.getOrderDiscount().validate(
+    const {
+      error: warrning,
+    } = RewardsApplicationValidator.getOrderDiscount().validate(
       { body },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getOrderDiscount",
+        message: `Parameter Validation warrnings for application > Rewards > getOrderDiscount \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -206,12 +226,18 @@ class Rewards {
       }),
       query_params,
       body,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = RewardsModel.OrderDiscountResponse().validate(response, {
+    } = RewardsApplicationModel.OrderDiscountResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -219,22 +245,22 @@ class Rewards {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getOrderDiscount",
+        message: `Response Validation Warnnings for application > Rewards > getOrderDiscount \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @returns {Promise<PointsResponse>} - Success response
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<RewardsApplicationModel.PointsResponse>} - Success response
+   * @name getUserPoints
    * @summary: Get total available points of a user
-   * @description: Use this API to retrieve total available points of a user for current application.
+   * @description: Use this API to retrieve total available points of a user for current application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getUserPoints/).
    */
-  async getUserPoints({} = {}) {
-    const { error } = RewardsValidator.getUserPoints().validate(
+  async getUserPoints({ headers } = { headers: false }) {
+    const { error } = RewardsApplicationValidator.getUserPoints().validate(
       {},
       { abortEarly: false, allowUnknown: true }
     );
@@ -243,16 +269,17 @@ class Rewards {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = RewardsValidator.getUserPoints().validate(
+    const {
+      error: warrning,
+    } = RewardsApplicationValidator.getUserPoints().validate(
       {},
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getUserPoints",
+        message: `Parameter Validation warrnings for application > Rewards > getUserPoints \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -268,12 +295,18 @@ class Rewards {
       }),
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = RewardsModel.PointsResponse().validate(response, {
+    } = RewardsApplicationModel.PointsResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -281,25 +314,29 @@ class Rewards {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getUserPoints",
+        message: `Response Validation Warnnings for application > Rewards > getUserPoints \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} [arg.pageId] - PageID is the ID of the requested page.
-   *   For first request it should be kept empty.
-   * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
-   * @returns {Promise<PointsHistoryResponse>} - Success response
+   * @param {RewardsApplicationValidator.GetUserPointsHistoryParam} arg - Arg object.
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<RewardsApplicationModel.PointsHistoryResponse>} -
+   *   Success response
+   * @name getUserPointsHistory
    * @summary: Get all transactions of reward points
-   * @description: Use this API to fetch a list of points transactions like giveaway points, signup points, referral points, order earn points, redeem points and expired points.
+   * @description: Use this API to fetch a list of points transactions like giveaway points, signup points, referral points, order earn points, redeem points and expired points. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getUserPointsHistory/).
    */
-  async getUserPointsHistory({ pageId, pageSize } = {}) {
-    const { error } = RewardsValidator.getUserPointsHistory().validate(
+  async getUserPointsHistory(
+    { pageId, pageSize } = {},
+    { headers } = { headers: false }
+  ) {
+    const {
+      error,
+    } = RewardsApplicationValidator.getUserPointsHistory().validate(
       { pageId, pageSize },
       { abortEarly: false, allowUnknown: true }
     );
@@ -310,16 +347,15 @@ class Rewards {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = RewardsValidator.getUserPointsHistory().validate(
+    } = RewardsApplicationValidator.getUserPointsHistory().validate(
       { pageId, pageSize },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getUserPointsHistory",
+        message: `Parameter Validation warrnings for application > Rewards > getUserPointsHistory \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -337,12 +373,18 @@ class Rewards {
       }),
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = RewardsModel.PointsHistoryResponse().validate(response, {
+    } = RewardsApplicationModel.PointsHistoryResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -350,9 +392,8 @@ class Rewards {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getUserPointsHistory",
+        message: `Response Validation Warnnings for application > Rewards > getUserPointsHistory \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
@@ -361,6 +402,7 @@ class Rewards {
   /**
    * @param {Object} arg - Arg object.
    * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
+   * @returns {Paginator<RewardsApplicationModel.PointsHistoryResponse>}
    * @summary: Get all transactions of reward points
    * @description: Use this API to fetch a list of points transactions like giveaway points, signup points, referral points, order earn points, redeem points and expired points.
    */
@@ -385,13 +427,17 @@ class Rewards {
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @returns {Promise<ReferralDetailsResponse>} - Success response
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<RewardsApplicationModel.ReferralDetailsResponse>} -
+   *   Success response
+   * @name getUserReferralDetails
    * @summary: Get referral details of a user
-   * @description: Use this API to retrieve the referral details like referral code of a user.
+   * @description: Use this API to retrieve the referral details like referral code of a user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getUserReferralDetails/).
    */
-  async getUserReferralDetails({} = {}) {
-    const { error } = RewardsValidator.getUserReferralDetails().validate(
+  async getUserReferralDetails({ headers } = { headers: false }) {
+    const {
+      error,
+    } = RewardsApplicationValidator.getUserReferralDetails().validate(
       {},
       { abortEarly: false, allowUnknown: true }
     );
@@ -402,16 +448,15 @@ class Rewards {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = RewardsValidator.getUserReferralDetails().validate(
+    } = RewardsApplicationValidator.getUserReferralDetails().validate(
       {},
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getUserReferralDetails",
+        message: `Parameter Validation warrnings for application > Rewards > getUserReferralDetails \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -427,36 +472,43 @@ class Rewards {
       }),
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = RewardsModel.ReferralDetailsResponse().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = RewardsApplicationModel.ReferralDetailsResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getUserReferralDetails",
+        message: `Response Validation Warnnings for application > Rewards > getUserReferralDetails \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {RedeemReferralCodeRequest} arg.body
-   * @returns {Promise<RedeemReferralCodeResponse>} - Success response
+   * @param {RewardsApplicationValidator.RedeemReferralCodeParam} arg - Arg object.
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<RewardsApplicationModel.RedeemReferralCodeResponse>} -
+   *   Success response
+   * @name redeemReferralCode
    * @summary: Redeems a referral code and credits reward points to referee and the referrer as per the configuration
-   * @description: Use this API to enter a referral code following which, the configured points would be credited to a user's reward points account.
+   * @description: Use this API to enter a referral code following which, the configured points would be credited to a user's reward points account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/redeemReferralCode/).
    */
-  async redeemReferralCode({ body } = {}) {
-    const { error } = RewardsValidator.redeemReferralCode().validate(
+  async redeemReferralCode({ body } = {}, { headers } = { headers: false }) {
+    const { error } = RewardsApplicationValidator.redeemReferralCode().validate(
       { body },
       { abortEarly: false, allowUnknown: true }
     );
@@ -465,16 +517,17 @@ class Rewards {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = RewardsValidator.redeemReferralCode().validate(
+    const {
+      error: warrning,
+    } = RewardsApplicationValidator.redeemReferralCode().validate(
       { body },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for redeemReferralCode",
+        message: `Parameter Validation warrnings for application > Rewards > redeemReferralCode \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -490,22 +543,27 @@ class Rewards {
       }),
       query_params,
       body,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = RewardsModel.RedeemReferralCodeResponse().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    } = RewardsApplicationModel.RedeemReferralCodeResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: false }
+    );
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for redeemReferralCode",
+        message: `Response Validation Warnnings for application > Rewards > redeemReferralCode \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;