@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

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

@@ -1,16 +1,16 @@
 export = RewardsValidator;
 declare class RewardsValidator {
-    static showGiveaways(): any;
-    static saveGiveAway(): any;
-    static getGiveawayById(): any;
-    static updateGiveAway(): any;
     static getGiveawayAudienceStatus(): any;
-    static showOffers(): any;
+    static getGiveawayById(): any;
     static getOfferByName(): any;
+    static getRewardsConfiguration(): any;
+    static getUserPointsHistory(): any;
+    static saveGiveAway(): any;
+    static setRewardsConfiguration(): any;
+    static showGiveaways(): any;
+    static showOffers(): any;
+    static updateGiveAway(): any;
     static updateOfferByName(): any;
     static updateUserStatus(): any;
     static user(): any;
-    static getUserPointsHistory(): any;
-    static getRewardsConfiguration(): any;
-    static setRewardsConfiguration(): any;
 }

package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js

@@ -2,35 +2,55 @@ const Joi = require("joi");
 const RewardsModel = require("./RewardsPlatformModel");
 
 class RewardsValidator {
-  static showGiveaways() {
+  static getGiveawayAudienceStatus() {
     return Joi.object({
-      pageId: Joi.string().allow("").required(),
-      pageSize: Joi.number().required(),
+      audienceId: Joi.string().allow("").required(),
     }).required();
   }
 
-  static saveGiveAway() {
+  static getGiveawayById() {
     return Joi.object({
-      body: RewardsModel.Giveaway().required(),
+      id: Joi.string().allow("").required(),
     }).required();
   }
 
-  static getGiveawayById() {
+  static getOfferByName() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
+      name: Joi.string().allow("").required(),
+
+      cookie: Joi.string().allow("").required(),
     }).required();
   }
 
-  static updateGiveAway() {
+  static getRewardsConfiguration() {
+    return Joi.object({}).required();
+  }
+
+  static getUserPointsHistory() {
+    return Joi.object({
+      userId: Joi.string().allow("").required(),
+
+      pageId: Joi.string().allow(""),
+      pageSize: Joi.number(),
+    }).required();
+  }
+
+  static saveGiveAway() {
     return Joi.object({
-      id: Joi.string().allow("").required(),
       body: RewardsModel.Giveaway().required(),
     }).required();
   }
 
-  static getGiveawayAudienceStatus() {
+  static setRewardsConfiguration() {
     return Joi.object({
-      audienceId: Joi.string().allow("").required(),
+      body: RewardsModel.ConfigurationRequest().required(),
+    }).required();
+  }
+
+  static showGiveaways() {
+    return Joi.object({
+      pageId: Joi.string().allow("").required(),
+      pageSize: Joi.number().required(),
     }).required();
   }
 
@@ -38,11 +58,10 @@ class RewardsValidator {
     return Joi.object({}).required();
   }
 
-  static getOfferByName() {
+  static updateGiveAway() {
     return Joi.object({
-      name: Joi.string().allow("").required(),
-
-      cookie: Joi.string().allow("").required(),
+      id: Joi.string().allow("").required(),
+      body: RewardsModel.Giveaway().required(),
     }).required();
   }
 
@@ -67,25 +86,6 @@ class RewardsValidator {
       userId: Joi.string().allow("").required(),
     }).required();
   }
-
-  static getUserPointsHistory() {
-    return Joi.object({
-      userId: Joi.string().allow("").required(),
-
-      pageId: Joi.string().allow(""),
-      pageSize: Joi.number(),
-    }).required();
-  }
-
-  static getRewardsConfiguration() {
-    return Joi.object({}).required();
-  }
-
-  static setRewardsConfiguration() {
-    return Joi.object({
-      body: RewardsModel.ConfigurationRequest().required(),
-    }).required();
-  }
 }
 
 module.exports = RewardsValidator;

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

@@ -1,24 +1,24 @@
 export = RewardsModel;
 declare class RewardsModel {
+    static AppUser(): any;
+    static Asset(): any;
+    static ConfigurationRequest(): any;
+    static ConfigurationRes(): any;
     static E(): any;
-    static GiveawayResponse(): any;
     static Giveaway(): any;
-    static Schedule(): any;
-    static RewardsAudience(): any;
-    static Asset(): any;
-    static RewardsRule(): any;
-    static Page(): any;
-    static Offer(): any;
-    static ShareMessages(): any;
-    static UserRes(): any;
-    static Points(): any;
-    static RewardUser(): any;
-    static Referral(): any;
-    static AppUser(): any;
     static GiveawayAudience(): any;
+    static GiveawayResponse(): any;
     static HistoryRes(): any;
+    static Offer(): any;
+    static Page(): any;
+    static Points(): any;
     static PointsHistory(): any;
-    static ConfigurationRes(): any;
+    static Referral(): any;
+    static RewardsAudience(): any;
+    static RewardsRule(): any;
+    static RewardUser(): any;
+    static Schedule(): any;
     static SetConfigurationRes(): any;
-    static ConfigurationRequest(): any;
+    static ShareMessages(): any;
+    static UserRes(): any;
 }

package/sdk/platform/Rewards/RewardsPlatformModel.js

@@ -1,293 +1,191 @@
 const Joi = require("joi");
 
 class RewardsModel {
+  static AppUser() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      active: Joi.boolean(),
+      application_id: Joi.string().allow(""),
+      block_reason: Joi.string().allow(""),
+      updated_at: Joi.string().allow(""),
+      updated_by: Joi.string().allow(""),
+      user_id: Joi.string().allow(""),
+    });
+  }
+  static Asset() {
+    return Joi.object({
+      aspect_ratio: Joi.string().allow(""),
+      id: Joi.string().allow(""),
+      secure_url: Joi.string().allow(""),
+    });
+  }
+  static ConfigurationRequest() {
+    return Joi.object({
+      terms_conditions_link: Joi.string().allow(""),
+      valid_android_packages: Joi.array().items(Joi.string().allow("")),
+    });
+  }
+  static ConfigurationRes() {
+    return Joi.object({
+      application_id: Joi.string().allow(""),
+      success: Joi.boolean(),
+      terms_conditions_link: Joi.string().allow(""),
+      valid_android_packages: Joi.array().items(Joi.string().allow("")),
+    });
+  }
   static E() {
     return Joi.object({
       code: Joi.number(),
-
       exception: Joi.string().allow(""),
-
       info: Joi.string().allow(""),
-
       message: Joi.string().allow(""),
     });
   }
-
-  static GiveawayResponse() {
-    return Joi.object({
-      items: Joi.array().items(RewardsModel.Giveaway()),
-
-      page: RewardsModel.Page(),
-    });
-  }
-
   static Giveaway() {
     return Joi.object({
       _id: Joi.string().allow(""),
-
       _schedule: RewardsModel.Schedule(),
-
       active: Joi.boolean(),
-
       application_id: Joi.string().allow(""),
-
       audience: RewardsModel.RewardsAudience(),
-
       banner_image: RewardsModel.Asset(),
-
       created_at: Joi.string().allow(""),
-
       description: Joi.string().allow(""),
-
       name: Joi.string().allow(""),
-
       rule: RewardsModel.RewardsRule(),
-
       title: Joi.string().allow(""),
-
       updated_at: Joi.string().allow(""),
     });
   }
-
-  static Schedule() {
-    return Joi.object({
-      duration: Joi.number(),
-
-      end: Joi.string().allow(""),
-
-      start: Joi.string().allow(""),
-
-      cron: Joi.string().allow(""),
-    });
-  }
-
-  static RewardsAudience() {
-    return Joi.object({
-      header_user_id: Joi.string().allow(""),
-
-      id: Joi.string().allow(""),
-    });
-  }
-
-  static Asset() {
+  static GiveawayAudience() {
     return Joi.object({
-      aspect_ratio: Joi.string().allow(""),
-
-      id: Joi.string().allow(""),
-
-      secure_url: Joi.string().allow(""),
+      audience_id: Joi.string().allow(""),
+      current_count: Joi.number(),
     });
   }
-
-  static RewardsRule() {
+  static GiveawayResponse() {
     return Joi.object({
-      amount: Joi.number(),
+      items: Joi.array().items(RewardsModel.Giveaway()),
+      page: RewardsModel.Page(),
     });
   }
-
-  static Page() {
+  static HistoryRes() {
     return Joi.object({
-      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(),
+      items: Joi.array().items(RewardsModel.PointsHistory()),
+      page: RewardsModel.Page(),
+      points: Joi.number(),
     });
   }
-
   static Offer() {
     return Joi.object({
       _schedule: RewardsModel.Schedule(),
-
       active: Joi.boolean(),
-
       application_id: Joi.string().allow(""),
-
       banner_image: RewardsModel.Asset(),
-
       created_at: Joi.string().allow(""),
-
       name: Joi.string().allow(""),
-
       rule: Joi.any(),
-
       share: RewardsModel.ShareMessages(),
-
       sub_text: Joi.string().allow(""),
-
       text: Joi.string().allow(""),
-
       type: Joi.string().allow(""),
-
       updated_at: Joi.string().allow(""),
-
       updated_by: Joi.string().allow(""),
-
       url: Joi.string().allow(""),
     });
   }
-
-  static ShareMessages() {
-    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(""),
-    });
-  }
-
-  static UserRes() {
+  static Page() {
     return Joi.object({
-      points: RewardsModel.Points(),
-
-      user: RewardsModel.RewardUser(),
+      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(),
     });
   }
-
   static Points() {
     return Joi.object({
       available: Joi.number(),
     });
   }
-
-  static RewardUser() {
+  static PointsHistory() {
     return Joi.object({
       _id: Joi.string().allow(""),
-
-      active: Joi.boolean(),
-
+      application_id: Joi.string().allow(""),
+      claimed: Joi.boolean(),
       created_at: Joi.string().allow(""),
-
-      referral: RewardsModel.Referral(),
-
-      uid: Joi.number(),
-
+      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_block_reason: Joi.string().allow(""),
-
       user_id: Joi.string().allow(""),
     });
   }
-
   static Referral() {
     return Joi.object({
       code: Joi.string().allow(""),
     });
   }
-
-  static AppUser() {
-    return Joi.object({
-      _id: Joi.string().allow(""),
-
-      active: Joi.boolean(),
-
-      application_id: Joi.string().allow(""),
-
-      block_reason: Joi.string().allow(""),
-
-      updated_at: Joi.string().allow(""),
-
-      updated_by: Joi.string().allow(""),
-
-      user_id: Joi.string().allow(""),
-    });
-  }
-
-  static GiveawayAudience() {
+  static RewardsAudience() {
     return Joi.object({
-      audience_id: Joi.string().allow(""),
-
-      current_count: Joi.number(),
+      header_user_id: Joi.string().allow(""),
+      id: Joi.string().allow(""),
     });
   }
-
-  static HistoryRes() {
+  static RewardsRule() {
     return Joi.object({
-      items: Joi.array().items(RewardsModel.PointsHistory()),
-
-      page: RewardsModel.Page(),
-
-      points: Joi.number(),
+      amount: Joi.number(),
     });
   }
-
-  static PointsHistory() {
+  static RewardUser() {
     return Joi.object({
       _id: Joi.string().allow(""),
-
-      application_id: Joi.string().allow(""),
-
-      claimed: Joi.boolean(),
-
+      active: 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(""),
-
+      referral: RewardsModel.Referral(),
+      uid: Joi.number(),
       updated_at: Joi.string().allow(""),
-
+      user_block_reason: Joi.string().allow(""),
       user_id: Joi.string().allow(""),
     });
   }
-
-  static ConfigurationRes() {
+  static Schedule() {
     return Joi.object({
-      valid_android_packages: Joi.array().items(Joi.string().allow("")),
-
-      terms_conditions_link: Joi.string().allow(""),
-
-      application_id: Joi.string().allow(""),
-
-      success: Joi.boolean(),
+      cron: Joi.string().allow(""),
+      duration: Joi.number(),
+      end: Joi.string().allow(""),
+      start: Joi.string().allow(""),
     });
   }
-
   static SetConfigurationRes() {
     return Joi.object({
       success: Joi.boolean(),
     });
   }
-
-  static ConfigurationRequest() {
+  static ShareMessages() {
     return Joi.object({
-      valid_android_packages: Joi.array().items(Joi.string().allow("")),
-
-      terms_conditions_link: Joi.string().allow(""),
+      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(""),
+    });
+  }
+  static UserRes() {
+    return Joi.object({
+      points: RewardsModel.Points(),
+      user: RewardsModel.RewardUser(),
     });
   }
 }

package/sdk/platform/Share/SharePlatformApplicationClient.d.ts

@@ -6,12 +6,23 @@ declare class Share {
     /**
      * @param {Object} arg - Arg object.
      * @param {ShortLinkReq} arg.body
+     * @returns {Promise<ShortLinkRes>} - Success response
      * @summary: Create short link
      * @description: Create short link
      */
     createShortLink({ body }?: {
         body: ShortLinkReq;
-    }): Promise<any>;
+    }): Promise<ShortLinkRes>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.hash - Hash of short url
+     * @returns {Promise<ShortLinkRes>} - Success response
+     * @summary: Get short link by hash
+     * @description: Get short link by hash
+     */
+    getShortLinkByHash({ hash }?: {
+        hash: string;
+    }): Promise<ShortLinkRes>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] - Current page number
@@ -19,6 +30,7 @@ declare class Share {
      * @param {string} [arg.createdBy] - Short link creator
      * @param {string} [arg.active] - Short link active status
      * @param {string} [arg.q] - Search text for original and short url
+     * @returns {Promise<ShortLinkList>} - Success response
      * @summary: Get short links
      * @description: Get short links
      */
@@ -28,7 +40,7 @@ declare class Share {
         createdBy?: string;
         active?: string;
         q?: string;
-    }): Promise<any>;
+    }): Promise<ShortLinkList>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Company Id
@@ -48,25 +60,17 @@ declare class Share {
         active?: string;
         q?: string;
     }): Paginator;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.hash - Hash of short url
-     * @summary: Get short link by hash
-     * @description: Get short link by hash
-     */
-    getShortLinkByHash({ hash }?: {
-        hash: string;
-    }): Promise<any>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Short link document identifier
      * @param {ShortLinkReq} arg.body
+     * @returns {Promise<ShortLinkRes>} - Success response
      * @summary: Update short link by id
      * @description: Update short link by id
      */
     updateShortLinkById({ id, body }?: {
         id: string;
         body: ShortLinkReq;
-    }): Promise<any>;
+    }): Promise<ShortLinkRes>;
 }
 import Paginator = require("../../common/Paginator");