@gofynd/fdk-client-javascript 1.4.14 → 1.4.15-beta.10

package/sdk/application/Rewards/RewardsApplicationModel.js

@@ -1,396 +0,0 @@
-const Joi = require("joi");
-
-/**
- * @typedef RewardsArticle
- * @property {string} [id]
- * @property {number} [points]
- * @property {number} [price]
- */
-
-/**
- * @typedef CatalogueOrderDetails
- * @property {RewardsArticle[]} [articles]
- */
-
-/**
- * @typedef CatalogueOrderCreation
- * @property {RewardsArticle[]} [articles]
- */
-
-/**
- * @typedef PointsDetails
- * @property {number} [points] - Total points available
- */
-
-/**
- * @typedef ReferralDetailsUser
- * @property {boolean} [blocked]
- * @property {number} [points]
- * @property {boolean} [redeemed]
- * @property {string} [referral_code]
- */
-
-/**
- * @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 Schedule
- * @property {number} [duration]
- * @property {string} [end]
- * @property {string} [start]
- * @property {string} [cron]
- */
-
-/**
- * @typedef Error
- * @property {number} [code]
- * @property {string} [exception]
- * @property {string} [info]
- * @property {string} [message]
- */
-
-/**
- * @typedef Asset
- * @property {string} [aspect_ratio]
- * @property {string} [id]
- * @property {string} [secure_url]
- */
-
-/**
- * @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 ReferralDetails
- * @property {Offer} [referral]
- * @property {ShareMessages} [share]
- * @property {ReferralDetailsUser} [user]
- * @property {string} [referrer_info]
- * @property {string} [terms_conditions_link]
- */
-
-/**
- * @typedef RetrieveOrderDiscount
- * @property {number} order_amount
- * @property {string} [currency]
- */
-
-/**
- * @typedef OrderDiscountRuleBucket
- * @property {number} [high]
- * @property {number} [low]
- * @property {number} [max]
- * @property {number} [value]
- * @property {string} [value_type]
- */
-
-/**
- * @typedef DiscountProperties
- * @property {number} [absolute]
- * @property {string} [currency]
- * @property {string} [display_absolute]
- * @property {string} [display_percent]
- * @property {number} [percent]
- */
-
-/**
- * @typedef OrderDiscountDetails
- * @property {number} [order_amount]
- * @property {number} [points]
- * @property {DiscountProperties} [discount]
- * @property {DiscountProperties} [base_discount]
- * @property {OrderDiscountRuleBucket} [applied_rule_bucket]
- */
-
-/**
- * @typedef RedeemReferralCode
- * @property {string} [device_id]
- * @property {string} [referral_code]
- */
-
-/**
- * @typedef RedeemReferralCodeDetails
- * @property {boolean} [redeemed]
- * @property {string} [message]
- * @property {string} [referrer_info]
- * @property {string} [referrer_id]
- * @property {number} [points]
- */
-
-/**
- * @typedef PointsHistoryDetails
- * @property {PointsHistory[]} [items] - History is the list of points transaction.
- * @property {Page} [page]
- */
-
-/**
- * @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 Page
- * @property {number} [item_total] - The total number of items on the page.
- * @property {string} [next_id] - The identifier for the next page.
- * @property {boolean} [has_previous] - Indicates whether there is a previous page.
- * @property {boolean} [has_next] - Indicates whether there is a next page.
- * @property {number} [current] - The current page number.
- * @property {string} type - The type of the page, such as 'PageType'.
- * @property {number} [size] - The number of items per page.
- */
-
-class RewardsApplicationModel {
-  /** @returns {RewardsArticle} */
-  static RewardsArticle() {
-    return Joi.object({
-      id: Joi.string().allow(""),
-      points: Joi.number(),
-      price: Joi.number(),
-    });
-  }
-
-  /** @returns {CatalogueOrderDetails} */
-  static CatalogueOrderDetails() {
-    return Joi.object({
-      articles: Joi.array().items(RewardsApplicationModel.RewardsArticle()),
-    });
-  }
-
-  /** @returns {CatalogueOrderCreation} */
-  static CatalogueOrderCreation() {
-    return Joi.object({
-      articles: Joi.array().items(RewardsApplicationModel.RewardsArticle()),
-    });
-  }
-
-  /** @returns {PointsDetails} */
-  static PointsDetails() {
-    return Joi.object({
-      points: Joi.number(),
-    });
-  }
-
-  /** @returns {ReferralDetailsUser} */
-  static ReferralDetailsUser() {
-    return Joi.object({
-      blocked: Joi.boolean(),
-      points: Joi.number(),
-      redeemed: Joi.boolean(),
-      referral_code: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {Offer} */
-  static Offer() {
-    return Joi.object({
-      _schedule: RewardsApplicationModel.Schedule(),
-      active: Joi.boolean(),
-      application_id: Joi.string().allow(""),
-      banner_image: RewardsApplicationModel.Asset(),
-      created_at: Joi.string().allow(""),
-      name: Joi.string().allow(""),
-      rule: Joi.object().pattern(/\S/, Joi.any()),
-      share: RewardsApplicationModel.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(""),
-    });
-  }
-
-  /** @returns {Schedule} */
-  static Schedule() {
-    return Joi.object({
-      duration: Joi.number(),
-      end: Joi.string().allow(""),
-      start: Joi.string().allow(""),
-      cron: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {Error} */
-  static Error() {
-    return Joi.object({
-      code: Joi.number(),
-      exception: Joi.string().allow(""),
-      info: Joi.string().allow(""),
-      message: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {Asset} */
-  static Asset() {
-    return Joi.object({
-      aspect_ratio: Joi.string().allow(""),
-      id: Joi.string().allow(""),
-      secure_url: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {ShareMessages} */
-  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(""),
-    });
-  }
-
-  /** @returns {ReferralDetails} */
-  static ReferralDetails() {
-    return Joi.object({
-      referral: RewardsApplicationModel.Offer(),
-      share: RewardsApplicationModel.ShareMessages(),
-      user: RewardsApplicationModel.ReferralDetailsUser(),
-      referrer_info: Joi.string().allow(""),
-      terms_conditions_link: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {RetrieveOrderDiscount} */
-  static RetrieveOrderDiscount() {
-    return Joi.object({
-      order_amount: Joi.number().required(),
-      currency: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {OrderDiscountRuleBucket} */
-  static OrderDiscountRuleBucket() {
-    return Joi.object({
-      high: Joi.number(),
-      low: Joi.number(),
-      max: Joi.number(),
-      value: Joi.number(),
-      value_type: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {DiscountProperties} */
-  static DiscountProperties() {
-    return Joi.object({
-      absolute: Joi.number(),
-      currency: Joi.string().allow(""),
-      display_absolute: Joi.string().allow(""),
-      display_percent: Joi.string().allow(""),
-      percent: Joi.number(),
-    });
-  }
-
-  /** @returns {OrderDiscountDetails} */
-  static OrderDiscountDetails() {
-    return Joi.object({
-      order_amount: Joi.number(),
-      points: Joi.number(),
-      discount: RewardsApplicationModel.DiscountProperties(),
-      base_discount: RewardsApplicationModel.DiscountProperties(),
-      applied_rule_bucket: RewardsApplicationModel.OrderDiscountRuleBucket(),
-    });
-  }
-
-  /** @returns {RedeemReferralCode} */
-  static RedeemReferralCode() {
-    return Joi.object({
-      device_id: Joi.string().allow(""),
-      referral_code: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {RedeemReferralCodeDetails} */
-  static RedeemReferralCodeDetails() {
-    return Joi.object({
-      redeemed: Joi.boolean(),
-      message: Joi.string().allow(""),
-      referrer_info: Joi.string().allow(""),
-      referrer_id: Joi.string().allow(""),
-      points: Joi.number(),
-    });
-  }
-
-  /** @returns {PointsHistoryDetails} */
-  static PointsHistoryDetails() {
-    return Joi.object({
-      items: Joi.array().items(RewardsApplicationModel.PointsHistory()),
-      page: RewardsApplicationModel.Page(),
-    });
-  }
-
-  /** @returns {PointsHistory} */
-  static PointsHistory() {
-    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.object().pattern(/\S/, 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 {Page} */
-  static Page() {
-    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(),
-    });
-  }
-}
-module.exports = RewardsApplicationModel;

package/sdk/application/Rewards/RewardsApplicationValidator.d.ts

@@ -1,73 +0,0 @@
-export = RewardsApplicationValidator;
-/**
- * @typedef CatalogueOrderParam
- * @property {RewardsApplicationModel.CatalogueOrderCreation} body
- */
-/**
- * @typedef GetOfferByNameParam
- * @property {string} name - The name given to the offer.
- */
-/**
- * @typedef GetOrderDiscountParam
- * @property {RewardsApplicationModel.RetrieveOrderDiscount} body
- */
-/** @typedef GetUserPointsParam */
-/**
- * @typedef GetUserPointsHistoryParam
- * @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 GetUserReferralDetailsParam */
-/**
- * @typedef RedeemReferralCodeParam
- * @property {RewardsApplicationModel.RedeemReferralCode} body
- */
-declare class RewardsApplicationValidator {
-    /** @returns {CatalogueOrderParam} */
-    static catalogueOrder(): CatalogueOrderParam;
-    /** @returns {GetOfferByNameParam} */
-    static getOfferByName(): GetOfferByNameParam;
-    /** @returns {GetOrderDiscountParam} */
-    static getOrderDiscount(): GetOrderDiscountParam;
-    /** @returns {GetUserPointsParam} */
-    static getUserPoints(): any;
-    /** @returns {GetUserPointsHistoryParam} */
-    static getUserPointsHistory(): GetUserPointsHistoryParam;
-    /** @returns {GetUserReferralDetailsParam} */
-    static getUserReferralDetails(): any;
-    /** @returns {RedeemReferralCodeParam} */
-    static redeemReferralCode(): RedeemReferralCodeParam;
-}
-declare namespace RewardsApplicationValidator {
-    export { CatalogueOrderParam, GetOfferByNameParam, GetOrderDiscountParam, GetUserPointsParam, GetUserPointsHistoryParam, GetUserReferralDetailsParam, RedeemReferralCodeParam };
-}
-type CatalogueOrderParam = {
-    body: RewardsApplicationModel.CatalogueOrderCreation;
-};
-type GetOfferByNameParam = {
-    /**
-     * - The name given to the offer.
-     */
-    name: string;
-};
-type GetOrderDiscountParam = {
-    body: RewardsApplicationModel.RetrieveOrderDiscount;
-};
-type GetUserPointsHistoryParam = {
-    /**
-     * - 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 RedeemReferralCodeParam = {
-    body: RewardsApplicationModel.RedeemReferralCode;
-};
-type GetUserPointsParam = any;
-type GetUserReferralDetailsParam = any;
-import RewardsApplicationModel = require("./RewardsApplicationModel");

package/sdk/application/Rewards/RewardsApplicationValidator.js

@@ -1,84 +0,0 @@
-const Joi = require("joi");
-
-const RewardsApplicationModel = require("./RewardsApplicationModel");
-
-/**
- * @typedef CatalogueOrderParam
- * @property {RewardsApplicationModel.CatalogueOrderCreation} body
- */
-
-/**
- * @typedef GetOfferByNameParam
- * @property {string} name - The name given to the offer.
- */
-
-/**
- * @typedef GetOrderDiscountParam
- * @property {RewardsApplicationModel.RetrieveOrderDiscount} body
- */
-
-/** @typedef GetUserPointsParam */
-
-/**
- * @typedef GetUserPointsHistoryParam
- * @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 GetUserReferralDetailsParam */
-
-/**
- * @typedef RedeemReferralCodeParam
- * @property {RewardsApplicationModel.RedeemReferralCode} body
- */
-
-class RewardsApplicationValidator {
-  /** @returns {CatalogueOrderParam} */
-  static catalogueOrder() {
-    return Joi.object({
-      body: RewardsApplicationModel.CatalogueOrderCreation().required(),
-    }).required();
-  }
-
-  /** @returns {GetOfferByNameParam} */
-  static getOfferByName() {
-    return Joi.object({
-      name: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {GetOrderDiscountParam} */
-  static getOrderDiscount() {
-    return Joi.object({
-      body: RewardsApplicationModel.RetrieveOrderDiscount().required(),
-    }).required();
-  }
-
-  /** @returns {GetUserPointsParam} */
-  static getUserPoints() {
-    return Joi.object({});
-  }
-
-  /** @returns {GetUserPointsHistoryParam} */
-  static getUserPointsHistory() {
-    return Joi.object({
-      pageId: Joi.string().allow(""),
-      pageSize: Joi.number(),
-    });
-  }
-
-  /** @returns {GetUserReferralDetailsParam} */
-  static getUserReferralDetails() {
-    return Joi.object({});
-  }
-
-  /** @returns {RedeemReferralCodeParam} */
-  static redeemReferralCode() {
-    return Joi.object({
-      body: RewardsApplicationModel.RedeemReferralCode().required(),
-    }).required();
-  }
-}
-
-module.exports = RewardsApplicationValidator;