@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts

@@ -1,15 +1,152 @@
-export = RewardsValidator;
-declare class RewardsValidator {
-    static getGiveawayById(): any;
-    static getOfferByName(): any;
+export = RewardsPlatformApplicationValidator;
+/**
+ * @typedef GetGiveawayByIdParam
+ * @property {string} id - Giveaway ID
+ */
+/**
+ * @typedef GetOfferByNameParam
+ * @property {string} name - The name given to the offer.
+ */
+/** @typedef GetRewardsConfigurationParam */
+/**
+ * @typedef GetUserDetailsParam
+ * @property {string} userId - User id
+ */
+/**
+ * @typedef GetUserPointsHistoryParam
+ * @property {string} userId - User id
+ * @property {string} [pageId] - PageID is the ID of the requested page. For
+ *   first request it should be kept empty.
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
+ */
+/**
+ * @typedef SaveGiveAwayParam
+ * @property {RewardsPlatformModel.Giveaway} body
+ */
+/**
+ * @typedef SetRewardsConfigurationParam
+ * @property {RewardsPlatformModel.ConfigurationRequest} body
+ */
+/**
+ * @typedef ShowGiveawaysParam
+ * @property {string} pageId - Pagination page id
+ * @property {number} pageSize - Pagination page size
+ */
+/** @typedef ShowOffersParam */
+/**
+ * @typedef UpdateGiveAwayParam
+ * @property {string} id - Giveaway ID
+ * @property {RewardsPlatformModel.Giveaway} body
+ */
+/**
+ * @typedef UpdateOfferByNameParam
+ * @property {string} name - The name given to the offer.
+ * @property {RewardsPlatformModel.Offer} body
+ */
+/**
+ * @typedef UpdateUserStatusParam
+ * @property {string} userId - User id
+ * @property {RewardsPlatformModel.AppUser} body
+ */
+declare class RewardsPlatformApplicationValidator {
+    /** @returns {GetGiveawayByIdParam} */
+    static getGiveawayById(): GetGiveawayByIdParam;
+    /** @returns {GetOfferByNameParam} */
+    static getOfferByName(): GetOfferByNameParam;
+    /** @returns {GetRewardsConfigurationParam} */
     static getRewardsConfiguration(): any;
-    static getUserDetails(): any;
-    static getUserPointsHistory(): any;
-    static saveGiveAway(): any;
-    static setRewardsConfiguration(): any;
-    static showGiveaways(): any;
+    /** @returns {GetUserDetailsParam} */
+    static getUserDetails(): GetUserDetailsParam;
+    /** @returns {GetUserPointsHistoryParam} */
+    static getUserPointsHistory(): GetUserPointsHistoryParam;
+    /** @returns {SaveGiveAwayParam} */
+    static saveGiveAway(): SaveGiveAwayParam;
+    /** @returns {SetRewardsConfigurationParam} */
+    static setRewardsConfiguration(): SetRewardsConfigurationParam;
+    /** @returns {ShowGiveawaysParam} */
+    static showGiveaways(): ShowGiveawaysParam;
+    /** @returns {ShowOffersParam} */
     static showOffers(): any;
-    static updateGiveAway(): any;
-    static updateOfferByName(): any;
-    static updateUserStatus(): any;
+    /** @returns {UpdateGiveAwayParam} */
+    static updateGiveAway(): UpdateGiveAwayParam;
+    /** @returns {UpdateOfferByNameParam} */
+    static updateOfferByName(): UpdateOfferByNameParam;
+    /** @returns {UpdateUserStatusParam} */
+    static updateUserStatus(): UpdateUserStatusParam;
 }
+declare namespace RewardsPlatformApplicationValidator {
+    export { GetGiveawayByIdParam, GetOfferByNameParam, GetRewardsConfigurationParam, GetUserDetailsParam, GetUserPointsHistoryParam, SaveGiveAwayParam, SetRewardsConfigurationParam, ShowGiveawaysParam, ShowOffersParam, UpdateGiveAwayParam, UpdateOfferByNameParam, UpdateUserStatusParam };
+}
+type GetGiveawayByIdParam = {
+    /**
+     * - Giveaway ID
+     */
+    id: string;
+};
+type GetOfferByNameParam = {
+    /**
+     * - The name given to the offer.
+     */
+    name: string;
+};
+type GetUserDetailsParam = {
+    /**
+     * - User id
+     */
+    userId: string;
+};
+type GetUserPointsHistoryParam = {
+    /**
+     * - User id
+     */
+    userId: string;
+    /**
+     * - PageID is the ID of the requested page. For
+     * first request it should be kept empty.
+     */
+    pageId?: string;
+    /**
+     * - The number of items to retrieve in each page.
+     */
+    pageSize?: number;
+};
+type SaveGiveAwayParam = {
+    body: RewardsPlatformModel.Giveaway;
+};
+type SetRewardsConfigurationParam = {
+    body: RewardsPlatformModel.ConfigurationRequest;
+};
+type ShowGiveawaysParam = {
+    /**
+     * - Pagination page id
+     */
+    pageId: string;
+    /**
+     * - Pagination page size
+     */
+    pageSize: number;
+};
+type UpdateGiveAwayParam = {
+    /**
+     * - Giveaway ID
+     */
+    id: string;
+    body: RewardsPlatformModel.Giveaway;
+};
+type UpdateOfferByNameParam = {
+    /**
+     * - The name given to the offer.
+     */
+    name: string;
+    body: RewardsPlatformModel.Offer;
+};
+type UpdateUserStatusParam = {
+    /**
+     * - User id
+     */
+    userId: string;
+    body: RewardsPlatformModel.AppUser;
+};
+type GetRewardsConfigurationParam = any;
+type ShowOffersParam = any;
+import RewardsPlatformModel = require("./RewardsPlatformModel");

package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js

@@ -1,29 +1,96 @@
 const Joi = require("joi");
 
-const RewardsModel = require("./RewardsPlatformModel");
-class RewardsValidator {
+const RewardsPlatformModel = require("./RewardsPlatformModel");
+
+/**
+ * @typedef GetGiveawayByIdParam
+ * @property {string} id - Giveaway ID
+ */
+
+/**
+ * @typedef GetOfferByNameParam
+ * @property {string} name - The name given to the offer.
+ */
+
+/** @typedef GetRewardsConfigurationParam */
+
+/**
+ * @typedef GetUserDetailsParam
+ * @property {string} userId - User id
+ */
+
+/**
+ * @typedef GetUserPointsHistoryParam
+ * @property {string} userId - User id
+ * @property {string} [pageId] - PageID is the ID of the requested page. For
+ *   first request it should be kept empty.
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
+ */
+
+/**
+ * @typedef SaveGiveAwayParam
+ * @property {RewardsPlatformModel.Giveaway} body
+ */
+
+/**
+ * @typedef SetRewardsConfigurationParam
+ * @property {RewardsPlatformModel.ConfigurationRequest} body
+ */
+
+/**
+ * @typedef ShowGiveawaysParam
+ * @property {string} pageId - Pagination page id
+ * @property {number} pageSize - Pagination page size
+ */
+
+/** @typedef ShowOffersParam */
+
+/**
+ * @typedef UpdateGiveAwayParam
+ * @property {string} id - Giveaway ID
+ * @property {RewardsPlatformModel.Giveaway} body
+ */
+
+/**
+ * @typedef UpdateOfferByNameParam
+ * @property {string} name - The name given to the offer.
+ * @property {RewardsPlatformModel.Offer} body
+ */
+
+/**
+ * @typedef UpdateUserStatusParam
+ * @property {string} userId - User id
+ * @property {RewardsPlatformModel.AppUser} body
+ */
+
+class RewardsPlatformApplicationValidator {
+  /** @returns {GetGiveawayByIdParam} */
   static getGiveawayById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetOfferByNameParam} */
   static getOfferByName() {
     return Joi.object({
       name: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetRewardsConfigurationParam} */
   static getRewardsConfiguration() {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetUserDetailsParam} */
   static getUserDetails() {
     return Joi.object({
       userId: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetUserPointsHistoryParam} */
   static getUserPointsHistory() {
     return Joi.object({
       userId: Joi.string().allow("").required(),
@@ -33,18 +100,21 @@ class RewardsValidator {
     }).required();
   }
 
+  /** @returns {SaveGiveAwayParam} */
   static saveGiveAway() {
     return Joi.object({
-      body: RewardsModel.Giveaway().required(),
+      body: RewardsPlatformModel.Giveaway().required(),
     }).required();
   }
 
+  /** @returns {SetRewardsConfigurationParam} */
   static setRewardsConfiguration() {
     return Joi.object({
-      body: RewardsModel.ConfigurationRequest().required(),
+      body: RewardsPlatformModel.ConfigurationRequest().required(),
     }).required();
   }
 
+  /** @returns {ShowGiveawaysParam} */
   static showGiveaways() {
     return Joi.object({
       pageId: Joi.string().allow("").required(),
@@ -52,32 +122,36 @@ class RewardsValidator {
     }).required();
   }
 
+  /** @returns {ShowOffersParam} */
   static showOffers() {
     return Joi.object({}).required();
   }
 
+  /** @returns {UpdateGiveAwayParam} */
   static updateGiveAway() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: RewardsModel.Giveaway().required(),
+      body: RewardsPlatformModel.Giveaway().required(),
     }).required();
   }
 
+  /** @returns {UpdateOfferByNameParam} */
   static updateOfferByName() {
     return Joi.object({
       name: Joi.string().allow("").required(),
 
-      body: RewardsModel.Offer().required(),
+      body: RewardsPlatformModel.Offer().required(),
     }).required();
   }
 
+  /** @returns {UpdateUserStatusParam} */
   static updateUserStatus() {
     return Joi.object({
       userId: Joi.string().allow("").required(),
 
-      body: RewardsModel.AppUser().required(),
+      body: RewardsPlatformModel.AppUser().required(),
     }).required();
   }
 }
 
-module.exports = RewardsValidator;
+module.exports = RewardsPlatformApplicationValidator;