@gofynd/fdk-client-javascript 1.1.6 → 1.3.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;

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

@@ -1,24 +1,361 @@
-export = RewardsModel;
-declare class RewardsModel {
-    static AppUser(): any;
-    static Asset(): any;
-    static ConfigurationRequest(): any;
-    static ConfigurationRes(): any;
-    static E(): any;
-    static Giveaway(): any;
-    static GiveawayAudience(): any;
-    static GiveawayResponse(): any;
-    static HistoryRes(): any;
-    static Offer(): any;
-    static Page(): any;
-    static Points(): any;
-    static PointsHistory(): any;
-    static Referral(): any;
-    static RewardsAudience(): any;
-    static RewardsRule(): any;
-    static RewardUser(): any;
-    static Schedule(): any;
-    static SetConfigurationRes(): any;
-    static ShareMessages(): any;
-    static UserRes(): any;
+export = RewardsPlatformModel;
+/**
+ * @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]
+ */
+declare class RewardsPlatformModel {
 }
+declare namespace RewardsPlatformModel {
+    export { AppUser, Asset, ConfigurationRequest, ConfigurationRes, E, Giveaway, GiveawayResponse, HistoryRes, Offer, Page, Points, PointsHistory, Referral, RewardsAudience, RewardsRule, RewardUser, Schedule, SetConfigurationRes, ShareMessages, UserRes };
+}
+/** @returns {AppUser} */
+declare function AppUser(): AppUser;
+type AppUser = {
+    _id?: string;
+    active?: boolean;
+    application_id?: string;
+    block_reason?: string;
+    updated_at?: string;
+    updated_by?: string;
+    user_id?: string;
+};
+/** @returns {Asset} */
+declare function Asset(): Asset;
+type Asset = {
+    aspect_ratio?: string;
+    id?: string;
+    secure_url?: string;
+};
+/** @returns {ConfigurationRequest} */
+declare function ConfigurationRequest(): ConfigurationRequest;
+type ConfigurationRequest = {
+    terms_conditions_link?: string;
+    valid_android_packages?: string[];
+};
+/** @returns {ConfigurationRes} */
+declare function ConfigurationRes(): ConfigurationRes;
+type ConfigurationRes = {
+    application_id?: string;
+    success?: boolean;
+    /**
+     * - A URL that redirects to the
+     * referral information suport page link
+     */
+    terms_conditions_link?: string;
+    /**
+     * - Contains array of string
+     * items, Valid android package names.
+     */
+    valid_android_packages?: string[];
+};
+/** @returns {E} */
+declare function E(): E;
+type E = {
+    code?: number;
+    exception?: string;
+    info?: string;
+    message?: string;
+};
+/** @returns {Giveaway} */
+declare function Giveaway(): Giveaway;
+type Giveaway = {
+    _id?: string;
+    _schedule?: Schedule;
+    active?: boolean;
+    application_id?: string;
+    audience?: RewardsAudience;
+    banner_image?: Asset;
+    created_at?: string;
+    description?: string;
+    name?: string;
+    rule?: RewardsRule;
+    title?: string;
+    updated_at?: string;
+};
+/** @returns {GiveawayResponse} */
+declare function GiveawayResponse(): GiveawayResponse;
+type GiveawayResponse = {
+    items?: Giveaway[];
+    page?: Page;
+};
+/** @returns {HistoryRes} */
+declare function HistoryRes(): HistoryRes;
+type HistoryRes = {
+    /**
+     * - History is the list of points transaction.
+     */
+    items?: PointsHistory[];
+    page?: Page;
+    points?: number;
+};
+/** @returns {Offer} */
+declare function Offer(): Offer;
+type Offer = {
+    _schedule?: Schedule;
+    active?: boolean;
+    application_id?: string;
+    banner_image?: Asset;
+    created_at?: string;
+    name?: string;
+    rule?: any;
+    share?: ShareMessages;
+    sub_text?: string;
+    text?: string;
+    type?: string;
+    updated_at?: string;
+    updated_by?: string;
+    url?: string;
+};
+/** @returns {Page} */
+declare function Page(): Page;
+type Page = {
+    current?: number;
+    has_next?: boolean;
+    has_previous?: boolean;
+    item_total?: number;
+    next_id?: string;
+    size?: number;
+    type: string;
+};
+/** @returns {Points} */
+declare function Points(): Points;
+type Points = {
+    available?: number;
+};
+/** @returns {PointsHistory} */
+declare function PointsHistory(): PointsHistory;
+type PointsHistory = {
+    _id?: string;
+    application_id?: string;
+    claimed?: boolean;
+    created_at?: string;
+    expires_on?: string;
+    meta?: any;
+    points?: number;
+    remaining_points?: number;
+    text_1?: string;
+    text_2?: string;
+    text_3?: string;
+    txn_name?: string;
+    updated_at?: string;
+    user_id?: string;
+};
+/** @returns {Referral} */
+declare function Referral(): Referral;
+type Referral = {
+    code?: string;
+};
+/** @returns {RewardsAudience} */
+declare function RewardsAudience(): RewardsAudience;
+type RewardsAudience = {
+    header_user_id?: string;
+    id?: string;
+};
+/** @returns {RewardsRule} */
+declare function RewardsRule(): RewardsRule;
+type RewardsRule = {
+    amount?: number;
+};
+/** @returns {RewardUser} */
+declare function RewardUser(): RewardUser;
+type RewardUser = {
+    _id?: string;
+    active?: boolean;
+    created_at?: string;
+    referral?: Referral;
+    uid?: number;
+    updated_at?: string;
+    user_block_reason?: string;
+    user_id?: string;
+};
+/** @returns {Schedule} */
+declare function Schedule(): Schedule;
+type Schedule = {
+    cron?: string;
+    duration?: number;
+    end?: string;
+    start?: string;
+};
+/** @returns {SetConfigurationRes} */
+declare function SetConfigurationRes(): SetConfigurationRes;
+type SetConfigurationRes = {
+    success?: boolean;
+};
+/** @returns {ShareMessages} */
+declare function ShareMessages(): ShareMessages;
+type ShareMessages = {
+    email?: number;
+    facebook?: string;
+    fallback?: string;
+    message?: string;
+    messenger?: string;
+    sms?: string;
+    text?: string;
+    twitter?: string;
+    whatsapp?: string;
+};
+/** @returns {UserRes} */
+declare function UserRes(): UserRes;
+type UserRes = {
+    points?: Points;
+    user?: RewardUser;
+};