@gofynd/fdk-client-javascript 1.0.2 → 1.0.3

package/sdk/application/Rewards/RewardsApplicationClient.js

@@ -10,16 +10,16 @@ class Rewards {
   constructor(_conf) {
     this._conf = _conf;
     this._relativeUrls = {
-      getOfferByName: "/service/application/rewards/v1.0/offers/{name}/",
       catalogueOrder:
         "/service/application/rewards/v1.0/catalogue/offer/order/",
+      getOfferByName: "/service/application/rewards/v1.0/offers/{name}/",
+      getOrderDiscount:
+        "/service/application/rewards/v1.0/user/offer/order-discount/",
+      getUserPoints: "/service/application/rewards/v1.0/user/points/",
       getUserPointsHistory:
         "/service/application/rewards/v1.0/user/points/history/",
-      getUserPoints: "/service/application/rewards/v1.0/user/points/",
       getUserReferralDetails:
         "/service/application/rewards/v1.0/user/referral/",
-      getOrderDiscount:
-        "/service/application/rewards/v1.0/user/offer/order-discount/",
       redeemReferralCode:
         "/service/application/rewards/v1.0/user/referral/redeem/",
     };
@@ -41,14 +41,14 @@ class Rewards {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.name - The name given to the offer.
-   * @returns {Promise<Offer>} - Success response
-   * @summary: Get offer by name
-   * @description: Use this API to get the offer details and configuration by entering the name of the offer.
+   * @param {CatalogueOrderRequest} arg.body
+   * @returns {Promise<CatalogueOrderResponse>} - Success response
+   * @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.
    */
-  async getOfferByName({ name } = {}) {
-    const { error } = RewardsValidator.getOfferByName().validate(
-      { name },
+  async catalogueOrder({ body } = {}) {
+    const { error } = RewardsValidator.catalogueOrder().validate(
+      { body },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -56,14 +56,14 @@ class Rewards {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = RewardsValidator.getOfferByName().validate(
-      { name },
+    const { error: warrning } = RewardsValidator.catalogueOrder().validate(
+      { body },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getOfferByName",
+        message: "Parameter Validation warrnings for catalogueOrder",
       });
       Logger({ level: "WARN", message: warrning });
     }
@@ -74,17 +74,19 @@ class Rewards {
 
     const response = await APIClient.execute(
       this._conf,
-      "get",
+      "post",
       constructUrl({
-        url: this._urls["getOfferByName"],
-        params: { name },
+        url: this._urls["catalogueOrder"],
+        params: {},
       }),
       query_params,
-      undefined,
+      body,
       xHeaders
     );
 
-    const { error: res_error } = RewardsModel.Offer().validate(response, {
+    const {
+      error: res_error,
+    } = RewardsModel.CatalogueOrderResponse().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -92,7 +94,7 @@ class Rewards {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getOfferByName",
+        message: "Response Validation Warnnings for catalogueOrder",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -102,14 +104,14 @@ class Rewards {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {CatalogueOrderRequest} arg.body
-   * @returns {Promise<CatalogueOrderResponse>} - Success response
-   * @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.
+   * @param {string} arg.name - The name given to the offer.
+   * @returns {Promise<Offer>} - Success response
+   * @summary: Get offer by name
+   * @description: Use this API to get the offer details and configuration by entering the name of the offer.
    */
-  async catalogueOrder({ body } = {}) {
-    const { error } = RewardsValidator.catalogueOrder().validate(
-      { body },
+  async getOfferByName({ name } = {}) {
+    const { error } = RewardsValidator.getOfferByName().validate(
+      { name },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -117,14 +119,14 @@ class Rewards {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = RewardsValidator.catalogueOrder().validate(
-      { body },
+    const { error: warrning } = RewardsValidator.getOfferByName().validate(
+      { name },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for catalogueOrder",
+        message: "Parameter Validation warrnings for getOfferByName",
       });
       Logger({ level: "WARN", message: warrning });
     }
@@ -135,19 +137,17 @@ class Rewards {
 
     const response = await APIClient.execute(
       this._conf,
-      "post",
+      "get",
       constructUrl({
-        url: this._urls["catalogueOrder"],
-        params: {},
+        url: this._urls["getOfferByName"],
+        params: { name },
       }),
       query_params,
-      body,
+      undefined,
       xHeaders
     );
 
-    const {
-      error: res_error,
-    } = RewardsModel.CatalogueOrderResponse().validate(response, {
+    const { error: res_error } = RewardsModel.Offer().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -155,7 +155,7 @@ class Rewards {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for catalogueOrder",
+        message: "Response Validation Warnnings for getOfferByName",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -165,16 +165,14 @@ class Rewards {
 
   /**
    * @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
-   * @summary: Get all transactions of reward points
-   * @description: Use this API to get a list of points transactions.
+   * @param {OrderDiscountRequest} arg.body
+   * @returns {Promise<OrderDiscountResponse>} - Success response
+   * @summary: Calculates the discount on order-amount
+   * @description: Use this API to calculate the discount on order-amount based on all the amount range configured in order_discount.
    */
-  async getUserPointsHistory({ pageId, pageSize } = {}) {
-    const { error } = RewardsValidator.getUserPointsHistory().validate(
-      { pageId, pageSize },
+  async getOrderDiscount({ body } = {}) {
+    const { error } = RewardsValidator.getOrderDiscount().validate(
+      { body },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -182,41 +180,37 @@ class Rewards {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = RewardsValidator.getUserPointsHistory().validate(
-      { pageId, pageSize },
+    const { error: warrning } = RewardsValidator.getOrderDiscount().validate(
+      { body },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getUserPointsHistory",
+        message: "Parameter Validation warrnings for getOrderDiscount",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
-    query_params["page_id"] = pageId;
-    query_params["page_size"] = pageSize;
 
     const xHeaders = {};
 
     const response = await APIClient.execute(
       this._conf,
-      "get",
+      "post",
       constructUrl({
-        url: this._urls["getUserPointsHistory"],
+        url: this._urls["getOrderDiscount"],
         params: {},
       }),
       query_params,
-      undefined,
+      body,
       xHeaders
     );
 
     const {
       error: res_error,
-    } = RewardsModel.PointsHistoryResponse().validate(response, {
+    } = RewardsModel.OrderDiscountResponse().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -224,7 +218,7 @@ class Rewards {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getUserPointsHistory",
+        message: "Response Validation Warnnings for getOrderDiscount",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -232,32 +226,6 @@ class Rewards {
     return response;
   }
 
-  /**
-   * @param {Object} arg - Arg object.
-   * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
-   * @summary: Get all transactions of reward points
-   * @description: Use this API to get a list of points transactions.
-   */
-  getUserPointsHistoryPaginator({ pageSize } = {}) {
-    const paginator = new Paginator();
-    const callback = async () => {
-      const pageId = paginator.nextId;
-      const pageNo = paginator.pageNo;
-      const pageType = "cursor";
-      const data = await this.getUserPointsHistory({
-        pageId: pageId,
-        pageSize: pageSize,
-      });
-      paginator.setPaginator({
-        hasNext: data.page.has_next ? true : false,
-        nextId: data.page.next_id,
-      });
-      return data;
-    };
-    paginator.setCallback(callback);
-    return paginator;
-  }
-
   /**
    * @param {Object} arg - Arg object.
    * @returns {Promise<PointsResponse>} - Success response
@@ -322,13 +290,16 @@ class Rewards {
 
   /**
    * @param {Object} arg - Arg object.
-   * @returns {Promise<ReferralDetailsResponse>} - Success response
-   * @summary: Get referral details of a user
-   * @description: Use this API to retrieve the referral details a user has configured in the application.
+   * @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
+   * @summary: Get all transactions of reward points
+   * @description: Use this API to get a list of points transactions.
    */
-  async getUserReferralDetails({} = {}) {
-    const { error } = RewardsValidator.getUserReferralDetails().validate(
-      {},
+  async getUserPointsHistory({ pageId, pageSize } = {}) {
+    const { error } = RewardsValidator.getUserPointsHistory().validate(
+      { pageId, pageSize },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -338,19 +309,21 @@ class Rewards {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = RewardsValidator.getUserReferralDetails().validate(
-      {},
+    } = RewardsValidator.getUserPointsHistory().validate(
+      { pageId, pageSize },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getUserReferralDetails",
+        message: "Parameter Validation warrnings for getUserPointsHistory",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
+    query_params["page_id"] = pageId;
+    query_params["page_size"] = pageSize;
 
     const xHeaders = {};
 
@@ -358,7 +331,7 @@ class Rewards {
       this._conf,
       "get",
       constructUrl({
-        url: this._urls["getUserReferralDetails"],
+        url: this._urls["getUserPointsHistory"],
         params: {},
       }),
       query_params,
@@ -368,7 +341,7 @@ class Rewards {
 
     const {
       error: res_error,
-    } = RewardsModel.ReferralDetailsResponse().validate(response, {
+    } = RewardsModel.PointsHistoryResponse().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -376,7 +349,7 @@ class Rewards {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getUserReferralDetails",
+        message: "Response Validation Warnnings for getUserPointsHistory",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -386,14 +359,39 @@ class Rewards {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {OrderDiscountRequest} arg.body
-   * @returns {Promise<OrderDiscountResponse>} - Success response
-   * @summary: Calculates the discount on order-amount
-   * @description: Use this API to calculate the discount on order-amount based on all the amount range configured in order_discount.
+   * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
+   * @summary: Get all transactions of reward points
+   * @description: Use this API to get a list of points transactions.
    */
-  async getOrderDiscount({ body } = {}) {
-    const { error } = RewardsValidator.getOrderDiscount().validate(
-      { body },
+  getUserPointsHistoryPaginator({ pageSize } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "cursor";
+      const data = await this.getUserPointsHistory({
+        pageId: pageId,
+        pageSize: pageSize,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback);
+    return paginator;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @returns {Promise<ReferralDetailsResponse>} - Success response
+   * @summary: Get referral details of a user
+   * @description: Use this API to retrieve the referral details a user has configured in the application.
+   */
+  async getUserReferralDetails({} = {}) {
+    const { error } = RewardsValidator.getUserReferralDetails().validate(
+      {},
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -401,14 +399,16 @@ class Rewards {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = RewardsValidator.getOrderDiscount().validate(
-      { body },
+    const {
+      error: warrning,
+    } = RewardsValidator.getUserReferralDetails().validate(
+      {},
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getOrderDiscount",
+        message: "Parameter Validation warrnings for getUserReferralDetails",
       });
       Logger({ level: "WARN", message: warrning });
     }
@@ -419,19 +419,19 @@ class Rewards {
 
     const response = await APIClient.execute(
       this._conf,
-      "post",
+      "get",
       constructUrl({
-        url: this._urls["getOrderDiscount"],
+        url: this._urls["getUserReferralDetails"],
         params: {},
       }),
       query_params,
-      body,
+      undefined,
       xHeaders
     );
 
     const {
       error: res_error,
-    } = RewardsModel.OrderDiscountResponse().validate(response, {
+    } = RewardsModel.ReferralDetailsResponse().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -439,7 +439,7 @@ class Rewards {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getOrderDiscount",
+        message: "Response Validation Warnnings for getUserReferralDetails",
       });
       Logger({ level: "WARN", message: res_error });
     }

package/sdk/application/Rewards/RewardsApplicationModel.d.ts

@@ -1,23 +1,23 @@
 export = RewardsModel;
 declare class RewardsModel {
-    static RewardsArticle(): any;
-    static CatalogueOrderResponse(): any;
+    static Asset(): any;
     static CatalogueOrderRequest(): any;
-    static PointsResponse(): any;
-    static ReferralDetailsUser(): any;
-    static Offer(): any;
-    static Schedule(): any;
+    static CatalogueOrderResponse(): any;
+    static DiscountProperties(): any;
     static Error(): any;
-    static Asset(): any;
-    static ShareMessages(): any;
-    static ReferralDetailsResponse(): any;
+    static Offer(): any;
     static OrderDiscountRequest(): any;
-    static OrderDiscountRuleBucket(): any;
-    static DiscountProperties(): any;
     static OrderDiscountResponse(): any;
+    static OrderDiscountRuleBucket(): any;
+    static Page(): any;
+    static PointsHistory(): any;
+    static PointsHistoryResponse(): any;
+    static PointsResponse(): any;
     static RedeemReferralCodeRequest(): any;
     static RedeemReferralCodeResponse(): any;
-    static PointsHistoryResponse(): any;
-    static PointsHistory(): any;
-    static Page(): any;
+    static ReferralDetailsResponse(): any;
+    static ReferralDetailsUser(): any;
+    static RewardsArticle(): any;
+    static Schedule(): any;
+    static ShareMessages(): any;
 }