@gofynd/fdk-client-javascript 1.0.2 → 1.0.3

package/sdk/application/Rewards/RewardsApplicationModel.js

@@ -1,275 +1,180 @@
 const Joi = require("joi");
 
 class RewardsModel {
-  static RewardsArticle() {
+  static Asset() {
     return Joi.object({
+      aspect_ratio: Joi.string().allow(""),
       id: Joi.string().allow(""),
-
-      points: Joi.number(),
-
-      price: Joi.number(),
+      secure_url: Joi.string().allow(""),
     });
   }
-
-  static CatalogueOrderResponse() {
+  static CatalogueOrderRequest() {
     return Joi.object({
       articles: Joi.array().items(RewardsModel.RewardsArticle()),
     });
   }
-
-  static CatalogueOrderRequest() {
+  static CatalogueOrderResponse() {
     return Joi.object({
       articles: Joi.array().items(RewardsModel.RewardsArticle()),
     });
   }
-
-  static PointsResponse() {
+  static DiscountProperties() {
     return Joi.object({
-      points: Joi.number(),
+      absolute: Joi.number(),
+      currency: Joi.string().allow(""),
+      display_absolute: Joi.string().allow(""),
+      display_percent: Joi.string().allow(""),
+      percent: Joi.number(),
     });
   }
-
-  static ReferralDetailsUser() {
+  static Error() {
     return Joi.object({
-      blocked: Joi.boolean(),
-
-      points: Joi.number(),
-
-      redeemed: Joi.boolean(),
-
-      referral_code: Joi.string().allow(""),
+      code: Joi.number(),
+      exception: Joi.string().allow(""),
+      info: Joi.string().allow(""),
+      message: Joi.string().allow(""),
     });
   }
-
   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 Schedule() {
-    return Joi.object({
-      duration: Joi.number(),
-
-      end: Joi.string().allow(""),
-
-      start: Joi.string().allow(""),
-
-      cron: Joi.string().allow(""),
-    });
-  }
-
-  static Error() {
-    return Joi.object({
-      code: Joi.number(),
-
-      exception: Joi.string().allow(""),
-
-      info: Joi.string().allow(""),
-
-      message: Joi.string().allow(""),
-    });
-  }
-
-  static Asset() {
-    return Joi.object({
-      aspect_ratio: Joi.string().allow(""),
-
-      id: Joi.string().allow(""),
-
-      secure_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 ReferralDetailsResponse() {
+  static OrderDiscountRequest() {
     return Joi.object({
-      referral: RewardsModel.Offer(),
-
-      share: RewardsModel.ShareMessages(),
-
-      user: RewardsModel.ReferralDetailsUser(),
-
-      referrer_info: Joi.string().allow(""),
-
-      terms_conditions_link: Joi.string().allow(""),
+      currency: Joi.string().allow(""),
+      order_amount: Joi.number().required(),
     });
   }
-
-  static OrderDiscountRequest() {
+  static OrderDiscountResponse() {
     return Joi.object({
-      order_amount: Joi.number().required(),
-
-      currency: Joi.string().allow(""),
+      applied_rule_bucket: RewardsModel.OrderDiscountRuleBucket(),
+      base_discount: RewardsModel.DiscountProperties(),
+      discount: RewardsModel.DiscountProperties(),
+      order_amount: Joi.number(),
+      points: Joi.number(),
     });
   }
-
   static OrderDiscountRuleBucket() {
     return Joi.object({
       high: Joi.number(),
-
       low: Joi.number(),
-
       max: Joi.number(),
-
       value: Joi.number(),
-
       value_type: Joi.string().allow(""),
     });
   }
-
-  static DiscountProperties() {
+  static Page() {
     return Joi.object({
-      absolute: Joi.number(),
-
-      currency: Joi.string().allow(""),
-
-      display_absolute: Joi.string().allow(""),
-
-      display_percent: Joi.string().allow(""),
-
-      percent: Joi.number(),
+      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 OrderDiscountResponse() {
+  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.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(""),
+    });
+  }
+  static PointsHistoryResponse() {
+    return Joi.object({
+      items: Joi.array().items(RewardsModel.PointsHistory()),
+      page: RewardsModel.Page(),
+    });
+  }
+  static PointsResponse() {
     return Joi.object({
-      order_amount: Joi.number(),
-
       points: Joi.number(),
-
-      discount: RewardsModel.DiscountProperties(),
-
-      base_discount: RewardsModel.DiscountProperties(),
-
-      applied_rule_bucket: RewardsModel.OrderDiscountRuleBucket(),
     });
   }
-
   static RedeemReferralCodeRequest() {
     return Joi.object({
       device_id: Joi.string().allow(""),
-
       referral_code: Joi.string().allow(""),
     });
   }
-
   static RedeemReferralCodeResponse() {
     return Joi.object({
-      redeemed: Joi.boolean(),
-
       message: Joi.string().allow(""),
-
-      referrer_info: Joi.string().allow(""),
-
-      referrer_id: Joi.string().allow(""),
-
       points: Joi.number(),
+      redeemed: Joi.boolean(),
+      referrer_id: Joi.string().allow(""),
+      referrer_info: Joi.string().allow(""),
     });
   }
-
-  static PointsHistoryResponse() {
+  static ReferralDetailsResponse() {
     return Joi.object({
-      items: Joi.array().items(RewardsModel.PointsHistory()),
-
-      page: RewardsModel.Page(),
+      referral: RewardsModel.Offer(),
+      referrer_info: Joi.string().allow(""),
+      share: RewardsModel.ShareMessages(),
+      terms_conditions_link: Joi.string().allow(""),
+      user: RewardsModel.ReferralDetailsUser(),
     });
   }
-
-  static PointsHistory() {
+  static ReferralDetailsUser() {
     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.any(),
-
+      blocked: Joi.boolean(),
       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(""),
+      redeemed: Joi.boolean(),
+      referral_code: Joi.string().allow(""),
     });
   }
-
-  static Page() {
+  static RewardsArticle() {
     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(),
+      id: Joi.string().allow(""),
+      points: Joi.number(),
+      price: Joi.number(),
+    });
+  }
+  static Schedule() {
+    return Joi.object({
+      cron: Joi.string().allow(""),
+      duration: Joi.number(),
+      end: Joi.string().allow(""),
+      start: 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(""),
     });
   }
 }

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

@@ -1,10 +1,10 @@
 export = RewardsValidator;
 declare class RewardsValidator {
-    static getOfferByName(): any;
     static catalogueOrder(): any;
-    static getUserPointsHistory(): any;
+    static getOfferByName(): any;
+    static getOrderDiscount(): any;
     static getUserPoints(): any;
+    static getUserPointsHistory(): any;
     static getUserReferralDetails(): any;
-    static getOrderDiscount(): any;
     static redeemReferralCode(): any;
 }

package/sdk/application/Rewards/RewardsApplicationValidator.js

@@ -2,18 +2,28 @@ const Joi = require("joi");
 
 const RewardsModel = require("./RewardsApplicationModel");
 class RewardsValidator {
+  static catalogueOrder() {
+    return Joi.object({
+      body: RewardsModel.CatalogueOrderRequest().required(),
+    }).required();
+  }
+
   static getOfferByName() {
     return Joi.object({
       name: Joi.string().allow("").required(),
     }).required();
   }
 
-  static catalogueOrder() {
+  static getOrderDiscount() {
     return Joi.object({
-      body: RewardsModel.CatalogueOrderRequest().required(),
+      body: RewardsModel.OrderDiscountRequest().required(),
     }).required();
   }
 
+  static getUserPoints() {
+    return Joi.object({});
+  }
+
   static getUserPointsHistory() {
     return Joi.object({
       pageId: Joi.string().allow(""),
@@ -21,20 +31,10 @@ class RewardsValidator {
     });
   }
 
-  static getUserPoints() {
-    return Joi.object({});
-  }
-
   static getUserReferralDetails() {
     return Joi.object({});
   }
 
-  static getOrderDiscount() {
-    return Joi.object({
-      body: RewardsModel.OrderDiscountRequest().required(),
-    }).required();
-  }
-
   static redeemReferralCode() {
     return Joi.object({
       body: RewardsModel.RedeemReferralCodeRequest().required(),

package/sdk/application/Share/ShareApplicationClient.d.ts

@@ -3,34 +3,33 @@ declare class Share {
     constructor(_conf: any);
     _conf: any;
     _relativeUrls: {
+        createShortLink: string;
         getApplicationQRCode: string;
-        getProductQRCodeBySlug: string;
         getCollectionQRCodeBySlug: string;
-        getUrlQRCode: string;
-        createShortLink: string;
-        getShortLinkByHash: string;
         getOriginalShortLinkByHash: string;
+        getProductQRCodeBySlug: string;
+        getShortLinkByHash: string;
+        getUrlQRCode: string;
     };
     _urls: {};
     updateUrls(urls: any): void;
     /**
      * @param {Object} arg - Arg object.
-     * @returns {Promise<QRCodeResp>} - Success response
-     * @summary: Create QR Code of an app
-     * @description: Use this API to create a QR code of an app for sharing it with users who want to use the app.
+     * @param {ShortLinkReq} arg.body
+     * @returns {Promise<ShortLinkRes>} - Success response
+     * @summary: Create a short link
+     * @description: Use this API to create a short link that is easy to write/share/read as compared to long URLs.
      */
-    getApplicationQRCode({}?: any): Promise<QRCodeResp>;
+    createShortLink({ body }?: {
+        body: ShortLinkReq;
+    }): Promise<ShortLinkRes>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.slug - A short, human-readable, URL-friendly
-     *   identifier of a product. You can get slug value from the endpoint.
      * @returns {Promise<QRCodeResp>} - Success response
-     * @summary: Create QR Code of a product
-     * @description: Use this API to create a QR code of a product for sharing it with users who want to view/purchase the product.
+     * @summary: Create QR Code of an app
+     * @description: Use this API to create a QR code of an app for sharing it with users who want to use the app.
      */
-    getProductQRCodeBySlug({ slug }?: {
-        slug: string;
-    }): Promise<QRCodeResp>;
+    getApplicationQRCode({}?: any): Promise<QRCodeResp>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.slug - A short, human-readable, URL-friendly
@@ -44,24 +43,26 @@ declare class Share {
     }): Promise<QRCodeResp>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.url - A link or a web address
-     * @returns {Promise<QRCodeResp>} - Success response
-     * @summary: Create QR Code of a URL
-     * @description: Use this API to create a QR code of a URL for sharing it with users who want to visit the link.
+     * @param {string} arg.hash - A string value used for converting long URL to
+     *   short URL and vice-versa.
+     * @returns {Promise<ShortLinkRes>} - Success response
+     * @summary: Get original link by hash
+     * @description: Use this API to retrieve the original link from a short-link by using a hash value.
      */
-    getUrlQRCode({ url }?: {
-        url: string;
-    }): Promise<QRCodeResp>;
+    getOriginalShortLinkByHash({ hash }?: {
+        hash: string;
+    }): Promise<ShortLinkRes>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {ShortLinkReq} arg.body
-     * @returns {Promise<ShortLinkRes>} - Success response
-     * @summary: Create a short link
-     * @description: Use this API to create a short link that is easy to write/share/read as compared to long URLs.
+     * @param {string} arg.slug - A short, human-readable, URL-friendly
+     *   identifier of a product. You can get slug value from the endpoint.
+     * @returns {Promise<QRCodeResp>} - Success response
+     * @summary: Create QR Code of a product
+     * @description: Use this API to create a QR code of a product for sharing it with users who want to view/purchase the product.
      */
-    createShortLink({ body }?: {
-        body: ShortLinkReq;
-    }): Promise<ShortLinkRes>;
+    getProductQRCodeBySlug({ slug }?: {
+        slug: string;
+    }): Promise<QRCodeResp>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.hash - A string value used for converting long URL to
@@ -75,13 +76,12 @@ declare class Share {
     }): Promise<ShortLinkRes>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.hash - A string value used for converting long URL to
-     *   short URL and vice-versa.
-     * @returns {Promise<ShortLinkRes>} - Success response
-     * @summary: Get original link by hash
-     * @description: Use this API to retrieve the original link from a short-link by using a hash value.
+     * @param {string} arg.url - A link or a web address
+     * @returns {Promise<QRCodeResp>} - Success response
+     * @summary: Create QR Code of a URL
+     * @description: Use this API to create a QR code of a URL for sharing it with users who want to visit the link.
      */
-    getOriginalShortLinkByHash({ hash }?: {
-        hash: string;
-    }): Promise<ShortLinkRes>;
+    getUrlQRCode({ url }?: {
+        url: string;
+    }): Promise<QRCodeResp>;
 }