@gofynd/fdk-client-javascript 1.4.1 → 1.4.2-beta.10

package/sdk/application/Rewards/RewardsApplicationModel.js

@@ -1,37 +1,33 @@
 const Joi = require("joi");
 
 /**
- * @typedef Asset
- * @property {string} [aspect_ratio]
+ * @typedef RewardsArticle
  * @property {string} [id]
- * @property {string} [secure_url]
+ * @property {number} [points]
+ * @property {number} [price]
  */
 
 /**
- * @typedef CatalogueOrderRequest
+ * @typedef CatalogueOrderResponse
  * @property {RewardsArticle[]} [articles]
  */
 
 /**
- * @typedef CatalogueOrderResponse
+ * @typedef CatalogueOrderRequest
  * @property {RewardsArticle[]} [articles]
  */
 
 /**
- * @typedef DiscountProperties
- * @property {number} [absolute]
- * @property {string} [currency]
- * @property {string} [display_absolute]
- * @property {string} [display_percent]
- * @property {number} [percent]
+ * @typedef PointsResponse
+ * @property {number} [points] - Total points available
  */
 
 /**
- * @typedef Error
- * @property {number} [code]
- * @property {string} [exception]
- * @property {string} [info]
- * @property {string} [message]
+ * @typedef ReferralDetailsUser
+ * @property {boolean} [blocked]
+ * @property {number} [points]
+ * @property {boolean} [redeemed]
+ * @property {string} [referral_code]
  */
 
 /**
@@ -53,171 +49,171 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef OrderDiscountRequest
- * @property {string} [currency]
- * @property {number} order_amount
+ * @typedef Schedule
+ * @property {number} [duration]
+ * @property {string} [end]
+ * @property {string} [start]
+ * @property {string} [cron]
  */
 
 /**
- * @typedef OrderDiscountResponse
- * @property {OrderDiscountRuleBucket} [applied_rule_bucket]
- * @property {DiscountProperties} [base_discount]
- * @property {DiscountProperties} [discount]
- * @property {number} [order_amount]
- * @property {number} [points]
+ * @typedef Error
+ * @property {number} [code]
+ * @property {string} [exception]
+ * @property {string} [info]
+ * @property {string} [message]
  */
 
 /**
- * @typedef OrderDiscountRuleBucket
- * @property {number} [high]
- * @property {number} [low]
- * @property {number} [max]
- * @property {number} [value]
- * @property {string} [value_type]
+ * @typedef Asset
+ * @property {string} [aspect_ratio]
+ * @property {string} [id]
+ * @property {string} [secure_url]
  */
 
 /**
- * @typedef Page
- * @property {number} [current]
- * @property {boolean} [has_next]
- * @property {boolean} [has_previous]
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {number} [size]
- * @property {string} type
+ * @typedef ShareMessages
+ * @property {number} [email]
+ * @property {string} [facebook]
+ * @property {string} [fallback]
+ * @property {string} [message]
+ * @property {string} [messenger]
+ * @property {string} [sms]
+ * @property {string} [text]
+ * @property {string} [twitter]
+ * @property {string} [whatsapp]
  */
 
 /**
- * @typedef PointsHistory
- * @property {string} [_id]
- * @property {string} [application_id]
- * @property {boolean} [claimed]
- * @property {string} [created_at]
- * @property {string} [expires_on]
- * @property {Object} [meta]
- * @property {number} [points]
- * @property {number} [remaining_points]
- * @property {string} [text_1]
- * @property {string} [text_2]
- * @property {string} [text_3]
- * @property {string} [txn_name]
- * @property {string} [updated_at]
- * @property {string} [user_id]
+ * @typedef ReferralDetailsResponse
+ * @property {Offer} [referral]
+ * @property {ShareMessages} [share]
+ * @property {ReferralDetailsUser} [user]
+ * @property {string} [referrer_info]
+ * @property {string} [terms_conditions_link]
  */
 
 /**
- * @typedef PointsHistoryResponse
- * @property {PointsHistory[]} [items] - History is the list of points transaction.
- * @property {Page} [page]
+ * @typedef OrderDiscountRequest
+ * @property {number} order_amount
+ * @property {string} [currency]
  */
 
 /**
- * @typedef PointsResponse
- * @property {number} [points] - Total points available
+ * @typedef OrderDiscountRuleBucket
+ * @property {number} [high]
+ * @property {number} [low]
+ * @property {number} [max]
+ * @property {number} [value]
+ * @property {string} [value_type]
  */
 
 /**
- * @typedef RedeemReferralCodeRequest
- * @property {string} [device_id]
- * @property {string} [referral_code]
+ * @typedef DiscountProperties
+ * @property {number} [absolute]
+ * @property {string} [currency]
+ * @property {string} [display_absolute]
+ * @property {string} [display_percent]
+ * @property {number} [percent]
  */
 
 /**
- * @typedef RedeemReferralCodeResponse
- * @property {string} [message]
+ * @typedef OrderDiscountResponse
+ * @property {number} [order_amount]
  * @property {number} [points]
- * @property {boolean} [redeemed]
- * @property {string} [referrer_id]
- * @property {string} [referrer_info]
+ * @property {DiscountProperties} [discount]
+ * @property {DiscountProperties} [base_discount]
+ * @property {OrderDiscountRuleBucket} [applied_rule_bucket]
  */
 
 /**
- * @typedef ReferralDetailsResponse
- * @property {Offer} [referral]
- * @property {string} [referrer_info]
- * @property {ShareMessages} [share]
- * @property {string} [terms_conditions_link]
- * @property {ReferralDetailsUser} [user]
+ * @typedef RedeemReferralCodeRequest
+ * @property {string} [device_id]
+ * @property {string} [referral_code]
  */
 
 /**
- * @typedef ReferralDetailsUser
- * @property {boolean} [blocked]
- * @property {number} [points]
+ * @typedef RedeemReferralCodeResponse
  * @property {boolean} [redeemed]
- * @property {string} [referral_code]
+ * @property {string} [message]
+ * @property {string} [referrer_info]
+ * @property {string} [referrer_id]
+ * @property {number} [points]
  */
 
 /**
- * @typedef RewardsArticle
- * @property {string} [id]
- * @property {number} [points]
- * @property {number} [price]
+ * @typedef PointsHistoryResponse
+ * @property {PointsHistory[]} [items] - History is the list of points transaction.
+ * @property {Page} [page]
  */
 
 /**
- * @typedef Schedule
- * @property {string} [cron]
- * @property {number} [duration]
- * @property {string} [end]
- * @property {string} [start]
+ * @typedef PointsHistory
+ * @property {string} [_id]
+ * @property {string} [application_id]
+ * @property {boolean} [claimed]
+ * @property {string} [created_at]
+ * @property {string} [expires_on]
+ * @property {Object} [meta]
+ * @property {number} [points]
+ * @property {number} [remaining_points]
+ * @property {string} [text_1]
+ * @property {string} [text_2]
+ * @property {string} [text_3]
+ * @property {string} [txn_name]
+ * @property {string} [updated_at]
+ * @property {string} [user_id]
  */
 
 /**
- * @typedef ShareMessages
- * @property {number} [email]
- * @property {string} [facebook]
- * @property {string} [fallback]
- * @property {string} [message]
- * @property {string} [messenger]
- * @property {string} [sms]
- * @property {string} [text]
- * @property {string} [twitter]
- * @property {string} [whatsapp]
+ * @typedef Page
+ * @property {number} [item_total]
+ * @property {string} [next_id]
+ * @property {boolean} [has_previous]
+ * @property {boolean} [has_next]
+ * @property {number} [current]
+ * @property {string} type
+ * @property {number} [size]
  */
 
 class RewardsApplicationModel {
-  /** @returns {Asset} */
-  static Asset() {
+  /** @returns {RewardsArticle} */
+  static RewardsArticle() {
     return Joi.object({
-      aspect_ratio: Joi.string().allow(""),
       id: Joi.string().allow(""),
-      secure_url: Joi.string().allow(""),
+      points: Joi.number(),
+      price: Joi.number(),
     });
   }
 
-  /** @returns {CatalogueOrderRequest} */
-  static CatalogueOrderRequest() {
+  /** @returns {CatalogueOrderResponse} */
+  static CatalogueOrderResponse() {
     return Joi.object({
       articles: Joi.array().items(RewardsApplicationModel.RewardsArticle()),
     });
   }
 
-  /** @returns {CatalogueOrderResponse} */
-  static CatalogueOrderResponse() {
+  /** @returns {CatalogueOrderRequest} */
+  static CatalogueOrderRequest() {
     return Joi.object({
       articles: Joi.array().items(RewardsApplicationModel.RewardsArticle()),
     });
   }
 
-  /** @returns {DiscountProperties} */
-  static DiscountProperties() {
+  /** @returns {PointsResponse} */
+  static PointsResponse() {
     return Joi.object({
-      absolute: Joi.number(),
-      currency: Joi.string().allow(""),
-      display_absolute: Joi.string().allow(""),
-      display_percent: Joi.string().allow(""),
-      percent: Joi.number(),
+      points: Joi.number(),
     });
   }
 
-  /** @returns {Error} */
-  static Error() {
+  /** @returns {ReferralDetailsUser} */
+  static ReferralDetailsUser() {
     return Joi.object({
-      code: Joi.number(),
-      exception: Joi.string().allow(""),
-      info: Joi.string().allow(""),
-      message: Joi.string().allow(""),
+      blocked: Joi.boolean(),
+      points: Joi.number(),
+      redeemed: Joi.boolean(),
+      referral_code: Joi.string().allow(""),
     });
   }
 
@@ -241,155 +237,159 @@ class RewardsApplicationModel {
     });
   }
 
-  /** @returns {OrderDiscountRequest} */
-  static OrderDiscountRequest() {
+  /** @returns {Schedule} */
+  static Schedule() {
     return Joi.object({
-      currency: Joi.string().allow(""),
-      order_amount: Joi.number().required(),
+      duration: Joi.number(),
+      end: Joi.string().allow(""),
+      start: Joi.string().allow(""),
+      cron: Joi.string().allow(""),
     });
   }
 
-  /** @returns {OrderDiscountResponse} */
-  static OrderDiscountResponse() {
+  /** @returns {Error} */
+  static Error() {
     return Joi.object({
-      applied_rule_bucket: RewardsApplicationModel.OrderDiscountRuleBucket(),
-      base_discount: RewardsApplicationModel.DiscountProperties(),
-      discount: RewardsApplicationModel.DiscountProperties(),
-      order_amount: Joi.number(),
-      points: Joi.number(),
+      code: Joi.number(),
+      exception: Joi.string().allow(""),
+      info: Joi.string().allow(""),
+      message: Joi.string().allow(""),
     });
   }
 
-  /** @returns {OrderDiscountRuleBucket} */
-  static OrderDiscountRuleBucket() {
+  /** @returns {Asset} */
+  static Asset() {
     return Joi.object({
-      high: Joi.number(),
-      low: Joi.number(),
-      max: Joi.number(),
-      value: Joi.number(),
-      value_type: Joi.string().allow(""),
+      aspect_ratio: Joi.string().allow(""),
+      id: Joi.string().allow(""),
+      secure_url: Joi.string().allow(""),
     });
   }
 
-  /** @returns {Page} */
-  static Page() {
+  /** @returns {ShareMessages} */
+  static ShareMessages() {
     return Joi.object({
-      current: Joi.number(),
-      has_next: Joi.boolean(),
-      has_previous: Joi.boolean(),
-      item_total: Joi.number(),
-      next_id: Joi.string().allow(""),
-      size: Joi.number(),
-      type: Joi.string().allow("").required(),
+      email: Joi.number(),
+      facebook: Joi.string().allow(""),
+      fallback: Joi.string().allow(""),
+      message: Joi.string().allow(""),
+      messenger: Joi.string().allow(""),
+      sms: Joi.string().allow(""),
+      text: Joi.string().allow(""),
+      twitter: Joi.string().allow(""),
+      whatsapp: Joi.string().allow(""),
     });
   }
 
-  /** @returns {PointsHistory} */
-  static PointsHistory() {
+  /** @returns {ReferralDetailsResponse} */
+  static ReferralDetailsResponse() {
     return Joi.object({
-      _id: Joi.string().allow(""),
-      application_id: Joi.string().allow(""),
-      claimed: Joi.boolean(),
-      created_at: Joi.string().allow(""),
-      expires_on: Joi.string().allow(""),
-      meta: Joi.any(),
-      points: Joi.number(),
-      remaining_points: Joi.number(),
-      text_1: Joi.string().allow(""),
-      text_2: Joi.string().allow(""),
-      text_3: Joi.string().allow(""),
-      txn_name: Joi.string().allow(""),
-      updated_at: Joi.string().allow(""),
-      user_id: Joi.string().allow(""),
+      referral: RewardsApplicationModel.Offer(),
+      share: RewardsApplicationModel.ShareMessages(),
+      user: RewardsApplicationModel.ReferralDetailsUser(),
+      referrer_info: Joi.string().allow(""),
+      terms_conditions_link: Joi.string().allow(""),
     });
   }
 
-  /** @returns {PointsHistoryResponse} */
-  static PointsHistoryResponse() {
+  /** @returns {OrderDiscountRequest} */
+  static OrderDiscountRequest() {
     return Joi.object({
-      items: Joi.array().items(RewardsApplicationModel.PointsHistory()),
-      page: RewardsApplicationModel.Page(),
+      order_amount: Joi.number().required(),
+      currency: Joi.string().allow(""),
     });
   }
 
-  /** @returns {PointsResponse} */
-  static PointsResponse() {
+  /** @returns {OrderDiscountRuleBucket} */
+  static OrderDiscountRuleBucket() {
     return Joi.object({
-      points: Joi.number(),
+      high: Joi.number(),
+      low: Joi.number(),
+      max: Joi.number(),
+      value: Joi.number(),
+      value_type: Joi.string().allow(""),
     });
   }
 
-  /** @returns {RedeemReferralCodeRequest} */
-  static RedeemReferralCodeRequest() {
+  /** @returns {DiscountProperties} */
+  static DiscountProperties() {
     return Joi.object({
-      device_id: Joi.string().allow(""),
-      referral_code: Joi.string().allow(""),
+      absolute: Joi.number(),
+      currency: Joi.string().allow(""),
+      display_absolute: Joi.string().allow(""),
+      display_percent: Joi.string().allow(""),
+      percent: Joi.number(),
     });
   }
 
-  /** @returns {RedeemReferralCodeResponse} */
-  static RedeemReferralCodeResponse() {
+  /** @returns {OrderDiscountResponse} */
+  static OrderDiscountResponse() {
     return Joi.object({
-      message: Joi.string().allow(""),
+      order_amount: Joi.number(),
       points: Joi.number(),
-      redeemed: Joi.boolean(),
-      referrer_id: Joi.string().allow(""),
-      referrer_info: Joi.string().allow(""),
+      discount: RewardsApplicationModel.DiscountProperties(),
+      base_discount: RewardsApplicationModel.DiscountProperties(),
+      applied_rule_bucket: RewardsApplicationModel.OrderDiscountRuleBucket(),
     });
   }
 
-  /** @returns {ReferralDetailsResponse} */
-  static ReferralDetailsResponse() {
+  /** @returns {RedeemReferralCodeRequest} */
+  static RedeemReferralCodeRequest() {
     return Joi.object({
-      referral: RewardsApplicationModel.Offer(),
-      referrer_info: Joi.string().allow(""),
-      share: RewardsApplicationModel.ShareMessages(),
-      terms_conditions_link: Joi.string().allow(""),
-      user: RewardsApplicationModel.ReferralDetailsUser(),
+      device_id: Joi.string().allow(""),
+      referral_code: Joi.string().allow(""),
     });
   }
 
-  /** @returns {ReferralDetailsUser} */
-  static ReferralDetailsUser() {
+  /** @returns {RedeemReferralCodeResponse} */
+  static RedeemReferralCodeResponse() {
     return Joi.object({
-      blocked: Joi.boolean(),
-      points: Joi.number(),
       redeemed: Joi.boolean(),
-      referral_code: Joi.string().allow(""),
+      message: Joi.string().allow(""),
+      referrer_info: Joi.string().allow(""),
+      referrer_id: Joi.string().allow(""),
+      points: Joi.number(),
     });
   }
 
-  /** @returns {RewardsArticle} */
-  static RewardsArticle() {
+  /** @returns {PointsHistoryResponse} */
+  static PointsHistoryResponse() {
     return Joi.object({
-      id: Joi.string().allow(""),
-      points: Joi.number(),
-      price: Joi.number(),
+      items: Joi.array().items(RewardsApplicationModel.PointsHistory()),
+      page: RewardsApplicationModel.Page(),
     });
   }
 
-  /** @returns {Schedule} */
-  static Schedule() {
+  /** @returns {PointsHistory} */
+  static PointsHistory() {
     return Joi.object({
-      cron: Joi.string().allow(""),
-      duration: Joi.number(),
-      end: Joi.string().allow(""),
-      start: Joi.string().allow(""),
+      _id: Joi.string().allow(""),
+      application_id: Joi.string().allow(""),
+      claimed: Joi.boolean(),
+      created_at: Joi.string().allow(""),
+      expires_on: Joi.string().allow(""),
+      meta: Joi.any(),
+      points: Joi.number(),
+      remaining_points: Joi.number(),
+      text_1: Joi.string().allow(""),
+      text_2: Joi.string().allow(""),
+      text_3: Joi.string().allow(""),
+      txn_name: Joi.string().allow(""),
+      updated_at: Joi.string().allow(""),
+      user_id: Joi.string().allow(""),
     });
   }
 
-  /** @returns {ShareMessages} */
-  static ShareMessages() {
+  /** @returns {Page} */
+  static Page() {
     return Joi.object({
-      email: Joi.number(),
-      facebook: Joi.string().allow(""),
-      fallback: Joi.string().allow(""),
-      message: Joi.string().allow(""),
-      messenger: Joi.string().allow(""),
-      sms: Joi.string().allow(""),
-      text: Joi.string().allow(""),
-      twitter: Joi.string().allow(""),
-      whatsapp: Joi.string().allow(""),
+      item_total: Joi.number(),
+      next_id: Joi.string().allow(""),
+      has_previous: Joi.boolean(),
+      has_next: Joi.boolean(),
+      current: Joi.number(),
+      type: Joi.string().allow("").required(),
+      size: Joi.number(),
     });
   }
 }