@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

package/sdk/platform/Rewards/RewardsPlatformModel.js

@@ -1,6 +1,190 @@
 const Joi = require("joi");
 
-class RewardsModel {
+/**
+ * @typedef AppUser
+ * @property {string} [_id]
+ * @property {boolean} [active]
+ * @property {string} [application_id]
+ * @property {string} [block_reason]
+ * @property {string} [updated_at]
+ * @property {string} [updated_by]
+ * @property {string} [user_id]
+ */
+
+/**
+ * @typedef Asset
+ * @property {string} [aspect_ratio]
+ * @property {string} [id]
+ * @property {string} [secure_url]
+ */
+
+/**
+ * @typedef ConfigurationRequest
+ * @property {string} [terms_conditions_link]
+ * @property {string[]} [valid_android_packages]
+ */
+
+/**
+ * @typedef ConfigurationRes
+ * @property {string} [application_id]
+ * @property {boolean} [success]
+ * @property {string} [terms_conditions_link] - A URL that redirects to the
+ *   referral information suport page link
+ * @property {string[]} [valid_android_packages] - Contains array of string
+ *   items, Valid android package names.
+ */
+
+/**
+ * @typedef E
+ * @property {number} [code]
+ * @property {string} [exception]
+ * @property {string} [info]
+ * @property {string} [message]
+ */
+
+/**
+ * @typedef Giveaway
+ * @property {string} [_id]
+ * @property {Schedule} [_schedule]
+ * @property {boolean} [active]
+ * @property {string} [application_id]
+ * @property {RewardsAudience} [audience]
+ * @property {Asset} [banner_image]
+ * @property {string} [created_at]
+ * @property {string} [description]
+ * @property {string} [name]
+ * @property {RewardsRule} [rule]
+ * @property {string} [title]
+ * @property {string} [updated_at]
+ */
+
+/**
+ * @typedef GiveawayResponse
+ * @property {Giveaway[]} [items]
+ * @property {Page} [page]
+ */
+
+/**
+ * @typedef HistoryRes
+ * @property {PointsHistory[]} [items] - History is the list of points transaction.
+ * @property {Page} [page]
+ * @property {number} [points]
+ */
+
+/**
+ * @typedef Offer
+ * @property {Schedule} [_schedule]
+ * @property {boolean} [active]
+ * @property {string} [application_id]
+ * @property {Asset} [banner_image]
+ * @property {string} [created_at]
+ * @property {string} [name]
+ * @property {Object} [rule]
+ * @property {ShareMessages} [share]
+ * @property {string} [sub_text]
+ * @property {string} [text]
+ * @property {string} [type]
+ * @property {string} [updated_at]
+ * @property {string} [updated_by]
+ * @property {string} [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 Points
+ * @property {number} [available]
+ */
+
+/**
+ * @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 Referral
+ * @property {string} [code]
+ */
+
+/**
+ * @typedef RewardsAudience
+ * @property {string} [header_user_id]
+ * @property {string} [id]
+ */
+
+/**
+ * @typedef RewardsRule
+ * @property {number} [amount]
+ */
+
+/**
+ * @typedef RewardUser
+ * @property {string} [_id]
+ * @property {boolean} [active]
+ * @property {string} [created_at]
+ * @property {Referral} [referral]
+ * @property {number} [uid]
+ * @property {string} [updated_at]
+ * @property {string} [user_block_reason]
+ * @property {string} [user_id]
+ */
+
+/**
+ * @typedef Schedule
+ * @property {string} [cron]
+ * @property {number} [duration]
+ * @property {string} [end]
+ * @property {string} [start]
+ */
+
+/**
+ * @typedef SetConfigurationRes
+ * @property {boolean} [success]
+ */
+
+/**
+ * @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 UserRes
+ * @property {Points} [points]
+ * @property {RewardUser} [user]
+ */
+
+class RewardsPlatformModel {
+  /** @returns {AppUser} */
   static AppUser() {
     return Joi.object({
       _id: Joi.string().allow(""),
@@ -12,6 +196,8 @@ class RewardsModel {
       user_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Asset} */
   static Asset() {
     return Joi.object({
       aspect_ratio: Joi.string().allow(""),
@@ -19,12 +205,16 @@ class RewardsModel {
       secure_url: Joi.string().allow(""),
     });
   }
+
+  /** @returns {ConfigurationRequest} */
   static ConfigurationRequest() {
     return Joi.object({
       terms_conditions_link: Joi.string().allow(""),
       valid_android_packages: Joi.array().items(Joi.string().allow("")),
     });
   }
+
+  /** @returns {ConfigurationRes} */
   static ConfigurationRes() {
     return Joi.object({
       application_id: Joi.string().allow(""),
@@ -33,6 +223,8 @@ class RewardsModel {
       valid_android_packages: Joi.array().items(Joi.string().allow("")),
     });
   }
+
+  /** @returns {E} */
   static E() {
     return Joi.object({
       code: Joi.number(),
@@ -41,51 +233,53 @@ class RewardsModel {
       message: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Giveaway} */
   static Giveaway() {
     return Joi.object({
       _id: Joi.string().allow(""),
-      _schedule: RewardsModel.Schedule(),
+      _schedule: RewardsPlatformModel.Schedule(),
       active: Joi.boolean(),
       application_id: Joi.string().allow(""),
-      audience: RewardsModel.RewardsAudience(),
-      banner_image: RewardsModel.Asset(),
+      audience: RewardsPlatformModel.RewardsAudience(),
+      banner_image: RewardsPlatformModel.Asset(),
       created_at: Joi.string().allow(""),
       description: Joi.string().allow(""),
       name: Joi.string().allow(""),
-      rule: RewardsModel.RewardsRule(),
+      rule: RewardsPlatformModel.RewardsRule(),
       title: Joi.string().allow(""),
       updated_at: Joi.string().allow(""),
     });
   }
-  static GiveawayAudience() {
-    return Joi.object({
-      audience_id: Joi.string().allow(""),
-      current_count: Joi.number(),
-    });
-  }
+
+  /** @returns {GiveawayResponse} */
   static GiveawayResponse() {
     return Joi.object({
-      items: Joi.array().items(RewardsModel.Giveaway()),
-      page: RewardsModel.Page(),
+      items: Joi.array().items(RewardsPlatformModel.Giveaway()),
+      page: RewardsPlatformModel.Page(),
     });
   }
+
+  /** @returns {HistoryRes} */
   static HistoryRes() {
     return Joi.object({
-      items: Joi.array().items(RewardsModel.PointsHistory()),
-      page: RewardsModel.Page(),
+      items: Joi.array().items(RewardsPlatformModel.PointsHistory()),
+      page: RewardsPlatformModel.Page(),
       points: Joi.number(),
     });
   }
+
+  /** @returns {Offer} */
   static Offer() {
     return Joi.object({
-      _schedule: RewardsModel.Schedule(),
+      _schedule: RewardsPlatformModel.Schedule(),
       active: Joi.boolean(),
       application_id: Joi.string().allow(""),
-      banner_image: RewardsModel.Asset(),
+      banner_image: RewardsPlatformModel.Asset(),
       created_at: Joi.string().allow(""),
       name: Joi.string().allow(""),
       rule: Joi.any(),
-      share: RewardsModel.ShareMessages(),
+      share: RewardsPlatformModel.ShareMessages(),
       sub_text: Joi.string().allow(""),
       text: Joi.string().allow(""),
       type: Joi.string().allow(""),
@@ -94,6 +288,8 @@ class RewardsModel {
       url: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Page} */
   static Page() {
     return Joi.object({
       current: Joi.number(),
@@ -105,11 +301,15 @@ class RewardsModel {
       type: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {Points} */
   static Points() {
     return Joi.object({
       available: Joi.number(),
     });
   }
+
+  /** @returns {PointsHistory} */
   static PointsHistory() {
     return Joi.object({
       _id: Joi.string().allow(""),
@@ -128,34 +328,44 @@ class RewardsModel {
       user_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Referral} */
   static Referral() {
     return Joi.object({
       code: Joi.string().allow(""),
     });
   }
+
+  /** @returns {RewardsAudience} */
   static RewardsAudience() {
     return Joi.object({
       header_user_id: Joi.string().allow(""),
       id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {RewardsRule} */
   static RewardsRule() {
     return Joi.object({
       amount: Joi.number(),
     });
   }
+
+  /** @returns {RewardUser} */
   static RewardUser() {
     return Joi.object({
       _id: Joi.string().allow(""),
       active: Joi.boolean(),
       created_at: Joi.string().allow(""),
-      referral: RewardsModel.Referral(),
+      referral: RewardsPlatformModel.Referral(),
       uid: Joi.number(),
       updated_at: Joi.string().allow(""),
       user_block_reason: Joi.string().allow(""),
       user_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Schedule} */
   static Schedule() {
     return Joi.object({
       cron: Joi.string().allow(""),
@@ -164,11 +374,15 @@ class RewardsModel {
       start: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SetConfigurationRes} */
   static SetConfigurationRes() {
     return Joi.object({
       success: Joi.boolean(),
     });
   }
+
+  /** @returns {ShareMessages} */
   static ShareMessages() {
     return Joi.object({
       email: Joi.number(),
@@ -182,11 +396,13 @@ class RewardsModel {
       whatsapp: Joi.string().allow(""),
     });
   }
+
+  /** @returns {UserRes} */
   static UserRes() {
     return Joi.object({
-      points: RewardsModel.Points(),
-      user: RewardsModel.RewardUser(),
+      points: RewardsPlatformModel.Points(),
+      user: RewardsPlatformModel.RewardUser(),
     });
   }
 }
-module.exports = RewardsModel;
+module.exports = RewardsPlatformModel;