@gofynd/fdk-client-javascript 1.1.0 → 1.1.2

package/sdk/application/PosCart/PosCartApplicationModel.d.ts

@@ -5,6 +5,7 @@ declare class PosCartModel {
     static AddCartRequest(): any;
     static AddProductCart(): any;
     static Address(): any;
+    static AppliedFreeArticles(): any;
     static AppliedPromotion(): any;
     static ApplyCouponRequest(): any;
     static ArticlePriceInfo(): any;
@@ -12,6 +13,7 @@ declare class PosCartModel {
     static BasePrice(): any;
     static BulkPriceOffer(): any;
     static BulkPriceResponse(): any;
+    static BuyRules(): any;
     static CartBreakup(): any;
     static CartCheckoutCustomMeta(): any;
     static CartCheckoutResponse(): any;
@@ -33,8 +35,10 @@ declare class PosCartModel {
     static CouponBreakup(): any;
     static CouponValidity(): any;
     static DeleteAddressResponse(): any;
+    static DiscountRulesApp(): any;
     static DisplayBreakup(): any;
     static Files(): any;
+    static FreeGiftItem(): any;
     static GeoLocation(): any;
     static GetAddressesResponse(): any;
     static GetCouponResponse(): any;

package/sdk/application/PosCart/PosCartApplicationModel.js

@@ -66,14 +66,29 @@ class PosCartModel {
       user_id: Joi.string().allow(""),
     });
   }
+  static AppliedFreeArticles() {
+    return Joi.object({
+      article_id: Joi.string().allow(""),
+      free_gift_item_details: PosCartModel.FreeGiftItem(),
+      parent_item_identifier: Joi.string().allow(""),
+      quantity: Joi.number(),
+    });
+  }
   static AppliedPromotion() {
     return Joi.object({
       amount: Joi.number(),
+      applied_free_articles: Joi.array().items(
+        PosCartModel.AppliedFreeArticles()
+      ),
       article_quantity: Joi.number(),
+      buy_rules: Joi.array().items(PosCartModel.BuyRules()),
+      discount_rules: Joi.array().items(PosCartModel.DiscountRulesApp()),
       mrp_promotion: Joi.boolean(),
       offer_text: Joi.string().allow(""),
       ownership: PosCartModel.Ownership(),
       promo_id: Joi.string().allow(""),
+      promotion_group: Joi.string().allow(""),
+      promotion_name: Joi.string().allow(""),
       promotion_type: Joi.string().allow(""),
     });
   }
@@ -113,6 +128,12 @@ class PosCartModel {
       data: Joi.array().items(PosCartModel.BulkPriceOffer()),
     });
   }
+  static BuyRules() {
+    return Joi.object({
+      cart_conditions: Joi.any(),
+      item_criteria: Joi.any(),
+    });
+  }
   static CartBreakup() {
     return Joi.object({
       coupon: PosCartModel.CouponBreakup(),
@@ -323,7 +344,9 @@ class PosCartModel {
   static Coupon() {
     return Joi.object({
       coupon_code: Joi.string().allow(""),
+      coupon_type: Joi.string().allow("").allow(null),
       coupon_value: Joi.number(),
+      description: Joi.string().allow("").allow(null),
       expires_on: Joi.string().allow(""),
       is_applicable: Joi.boolean(),
       is_applied: Joi.boolean(),
@@ -337,8 +360,15 @@ class PosCartModel {
   static CouponBreakup() {
     return Joi.object({
       code: Joi.string().allow(""),
+      coupon_type: Joi.string().allow("").allow(null),
+      coupon_value: Joi.number(),
+      description: Joi.string().allow("").allow(null),
       is_applied: Joi.boolean(),
+      max_discount_value: Joi.number(),
       message: Joi.string().allow(""),
+      minimum_cart_value: Joi.number(),
+      sub_title: Joi.string().allow("").allow(null),
+      title: Joi.string().allow("").allow(null),
       type: Joi.string().allow(""),
       uid: Joi.string().allow(""),
       value: Joi.number(),
@@ -359,6 +389,14 @@ class PosCartModel {
       is_deleted: Joi.boolean(),
     });
   }
+  static DiscountRulesApp() {
+    return Joi.object({
+      item_criteria: Joi.any(),
+      matched_buy_rules: Joi.array().items(Joi.string().allow("")),
+      offer: Joi.any(),
+      raw_offer: Joi.any(),
+    });
+  }
   static DisplayBreakup() {
     return Joi.object({
       currency_code: Joi.string().allow(""),
@@ -375,6 +413,16 @@ class PosCartModel {
       values: Joi.array().items(Joi.string().allow("")).required(),
     });
   }
+  static FreeGiftItem() {
+    return Joi.object({
+      item_brand_name: Joi.string().allow(""),
+      item_id: Joi.number(),
+      item_images_url: Joi.array().items(Joi.string().allow("")),
+      item_name: Joi.string().allow(""),
+      item_price_details: Joi.any(),
+      item_slug: Joi.string().allow(""),
+    });
+  }
   static GeoLocation() {
     return Joi.object({
       latitude: Joi.number(),
@@ -499,11 +547,13 @@ class PosCartModel {
     return Joi.object({
       _custom_json: Joi.any(),
       extra_meta: Joi.any(),
+      identifier: Joi.any(),
       parent_item_identifiers: Joi.any(),
       price: PosCartModel.ArticlePriceInfo(),
       product_group_tags: Joi.array().items(Joi.string().allow("")),
       quantity: Joi.number(),
       seller: PosCartModel.BaseInfo(),
+      seller_identifier: Joi.string().allow(""),
       size: Joi.string().allow(""),
       store: PosCartModel.BaseInfo(),
       type: Joi.string().allow(""),

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

@@ -28,7 +28,7 @@ declare class Rewards {
      * @param {string} arg.name - The name given to the offer.
      * @returns {Promise<Offer>} - Success response
      * @summary: Get offer by name
-     * @description: Use this API to get the offer details and configuration by entering the name of the offer.
+     * @description: Use this API to get fetch the specific offer details and configuration by the name of the offer.
      */
     getOfferByName({ name }?: {
         name: string;
@@ -38,7 +38,7 @@ declare class Rewards {
      * @param {OrderDiscountRequest} arg.body
      * @returns {Promise<OrderDiscountResponse>} - Success response
      * @summary: Calculates the discount on order-amount
-     * @description: Use this API to calculate the discount on order-amount based on all the amount range configured in order_discount.
+     * @description: Use this API to calculate the discount on the order amount, based on all the amount range configured in Order Discount offer.
      */
     getOrderDiscount({ body }?: {
         body: OrderDiscountRequest;
@@ -46,8 +46,8 @@ declare class Rewards {
     /**
      * @param {Object} arg - Arg object.
      * @returns {Promise<PointsResponse>} - Success response
-     * @summary: Get referral details of a user
-     * @description: Use this API to retrieve total available points of a user for current application
+     * @summary: Get total available points of a user
+     * @description: Use this API to retrieve total available points of a user for current application.
      */
     getUserPoints({}?: any): Promise<PointsResponse>;
     /**
@@ -57,7 +57,7 @@ declare class Rewards {
      * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
      * @returns {Promise<PointsHistoryResponse>} - Success response
      * @summary: Get all transactions of reward points
-     * @description: Use this API to get a list of points transactions.
+     * @description: Use this API to fetch a list of points transactions like giveaway points, signup points, referral points, order earn points, redeem points and expired points.
      */
     getUserPointsHistory({ pageId, pageSize }?: {
         pageId?: string;
@@ -67,7 +67,7 @@ declare class Rewards {
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
      * @summary: Get all transactions of reward points
-     * @description: Use this API to get a list of points transactions.
+     * @description: Use this API to fetch a list of points transactions like giveaway points, signup points, referral points, order earn points, redeem points and expired points.
      */
     getUserPointsHistoryPaginator({ pageSize }?: {
         pageSize?: number;
@@ -76,14 +76,14 @@ declare class Rewards {
      * @param {Object} arg - Arg object.
      * @returns {Promise<ReferralDetailsResponse>} - Success response
      * @summary: Get referral details of a user
-     * @description: Use this API to retrieve the referral details a user has configured in the application.
+     * @description: Use this API to retrieve the referral details like referral code of a user.
      */
     getUserReferralDetails({}?: any): Promise<ReferralDetailsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {RedeemReferralCodeRequest} arg.body
      * @returns {Promise<RedeemReferralCodeResponse>} - Success response
-     * @summary: Redeems a referral code and credits reward points to users
+     * @summary: Redeems a referral code and credits reward points to referee and the referrer as per the configuration
      * @description: Use this API to enter a referral code following which, the configured points would be credited to a user's reward points account.
      */
     redeemReferralCode({ body }?: {

package/sdk/application/Rewards/RewardsApplicationClient.js

@@ -108,7 +108,7 @@ class Rewards {
    * @param {string} arg.name - The name given to the offer.
    * @returns {Promise<Offer>} - Success response
    * @summary: Get offer by name
-   * @description: Use this API to get the offer details and configuration by entering the name of the offer.
+   * @description: Use this API to get fetch the specific offer details and configuration by the name of the offer.
    */
   async getOfferByName({ name } = {}) {
     const { error } = RewardsValidator.getOfferByName().validate(
@@ -169,7 +169,7 @@ class Rewards {
    * @param {OrderDiscountRequest} arg.body
    * @returns {Promise<OrderDiscountResponse>} - Success response
    * @summary: Calculates the discount on order-amount
-   * @description: Use this API to calculate the discount on order-amount based on all the amount range configured in order_discount.
+   * @description: Use this API to calculate the discount on the order amount, based on all the amount range configured in Order Discount offer.
    */
   async getOrderDiscount({ body } = {}) {
     const { error } = RewardsValidator.getOrderDiscount().validate(
@@ -230,8 +230,8 @@ class Rewards {
   /**
    * @param {Object} arg - Arg object.
    * @returns {Promise<PointsResponse>} - Success response
-   * @summary: Get referral details of a user
-   * @description: Use this API to retrieve total available points of a user for current application
+   * @summary: Get total available points of a user
+   * @description: Use this API to retrieve total available points of a user for current application.
    */
   async getUserPoints({} = {}) {
     const { error } = RewardsValidator.getUserPoints().validate(
@@ -296,7 +296,7 @@ class Rewards {
    * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
    * @returns {Promise<PointsHistoryResponse>} - Success response
    * @summary: Get all transactions of reward points
-   * @description: Use this API to get a list of points transactions.
+   * @description: Use this API to fetch a list of points transactions like giveaway points, signup points, referral points, order earn points, redeem points and expired points.
    */
   async getUserPointsHistory({ pageId, pageSize } = {}) {
     const { error } = RewardsValidator.getUserPointsHistory().validate(
@@ -362,7 +362,7 @@ class Rewards {
    * @param {Object} arg - Arg object.
    * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
    * @summary: Get all transactions of reward points
-   * @description: Use this API to get a list of points transactions.
+   * @description: Use this API to fetch a list of points transactions like giveaway points, signup points, referral points, order earn points, redeem points and expired points.
    */
   getUserPointsHistoryPaginator({ pageSize } = {}) {
     const paginator = new Paginator();
@@ -388,7 +388,7 @@ class Rewards {
    * @param {Object} arg - Arg object.
    * @returns {Promise<ReferralDetailsResponse>} - Success response
    * @summary: Get referral details of a user
-   * @description: Use this API to retrieve the referral details a user has configured in the application.
+   * @description: Use this API to retrieve the referral details like referral code of a user.
    */
   async getUserReferralDetails({} = {}) {
     const { error } = RewardsValidator.getUserReferralDetails().validate(
@@ -452,7 +452,7 @@ class Rewards {
    * @param {Object} arg - Arg object.
    * @param {RedeemReferralCodeRequest} arg.body
    * @returns {Promise<RedeemReferralCodeResponse>} - Success response
-   * @summary: Redeems a referral code and credits reward points to users
+   * @summary: Redeems a referral code and credits reward points to referee and the referrer as per the configuration
    * @description: Use this API to enter a referral code following which, the configured points would be credited to a user's reward points account.
    */
   async redeemReferralCode({ body } = {}) {

package/sdk/common/AxiosHelper.js

@@ -38,7 +38,7 @@ function requestInterceptorFn() {
     }
     const { host, pathname, search } = new URL(url);
     const { data, headers, method, params } = config;
-    headers["x-fp-sdk-version"] = "1.0.3";
+    headers["x-fp-sdk-version"] = "1.1.2";
     let querySearchObj = querystring.parse(search);
     querySearchObj = { ...querySearchObj, ...params };
     let queryParam = "";

package/sdk/common/Constant.d.ts

@@ -20,8 +20,6 @@ export namespace AVAILABLE_PAGE_TYPE {
     const PAGE: string;
     const POLICY: string;
     const PRODUCT: string;
-    const PRODUCT_REVIEWS: string;
-    const ADD_PRODUCT_REVIEW: string;
     const PRODUCT_REQUEST: string;
     const PRODUCTS: string;
     const PROFILE: string;
@@ -168,22 +166,6 @@ export const NAVIGATORS: {
             required: boolean;
         }[];
     };
-    "product-reviews": {
-        name: string;
-        link: string;
-        params: {
-            key: string;
-            required: boolean;
-        }[];
-    };
-    "add-product-review": {
-        name: string;
-        link: string;
-        params: {
-            key: string;
-            required: boolean;
-        }[];
-    };
     "product-request": {
         name: string;
         link: string;

package/sdk/common/Constant.js

@@ -20,8 +20,6 @@ const AVAILABLE_PAGE_TYPE = {
   PAGE: "page",
   POLICY: "policy",
   PRODUCT: "product",
-  PRODUCT_REVIEWS: "product-reviews",
-  ADD_PRODUCT_REVIEW: "add-product-review",
   PRODUCT_REQUEST: "product-request",
   PRODUCTS: "products",
   PROFILE: "profile",
@@ -189,26 +187,6 @@ const NAVIGATORS = {
       },
     ],
   },
-  "product-reviews": {
-    name: "Product Reviews",
-    link: "/product/:slug/reviews",
-    params: [
-      {
-        key: "slug",
-        required: true,
-      },
-    ],
-  },
-  "add-product-review": {
-    name: "Add Product review",
-    link: "/product/:slug/add-review",
-    params: [
-      {
-        key: "slug",
-        required: true,
-      },
-    ],
-  },
   "product-request": {
     name: "Product Request",
     link: "/product-request/",

package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts

@@ -37,6 +37,16 @@ declare class Cart {
     checkoutCart({ body }?: {
         body: OpenApiPlatformCheckoutReq;
     }): Promise<OpenApiCheckoutResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {CartMetaConfigAdd} arg.body
+     * @returns {Promise<CartMetaConfigAdd>} - Success response
+     * @summary: Create new cart meta configuration
+     * @description: Create new cart meta configuration
+     */
+    createCartMetaConfig({ body }?: {
+        body: CartMetaConfigAdd;
+    }): Promise<CartMetaConfigAdd>;
     /**
      * @param {Object} arg - Arg object.
      * @param {CouponAdd} arg.body
@@ -67,6 +77,13 @@ declare class Cart {
     fetchAndvalidateCartItems({ body }?: {
         body: OpenapiCartDetailsRequest;
     }): Promise<OpenapiCartDetailsResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<CartMetaConfigAdd>} - Success response
+     * @summary: Fetch cart meta configuration
+     * @description: Fetch cart meta configuration
+     */
+    fetchCartMetaConfig({}?: any): Promise<CartMetaConfigAdd>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] -
@@ -202,6 +219,18 @@ declare class Cart {
         typeSlug?: string;
         code?: string;
     }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.entityType] - Entity_type as coupon or promotion
+     * @param {boolean} [arg.isHidden] - Show Promo Coupon Config or not
+     * @returns {Promise<ActivePromosResponse>} - Success response
+     * @summary: Fetch all promos that are set as active
+     * @description: Use this API to get list of all the active promos/coupons.
+     */
+    getPromosCouponConfig({ entityType, isHidden }?: {
+        entityType?: string;
+        isHidden?: boolean;
+    }): Promise<ActivePromosResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id -
@@ -271,6 +300,16 @@ declare class Cart {
         fpPanel?: string;
         promotionId?: string;
     }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {OverrideCheckoutReq} arg.body
+     * @returns {Promise<OverrideCheckoutResponse>} - Success response
+     * @summary: Create Fynd order with overriding cart details
+     * @description: Generate Fynd order while overriding cart details sent with provided `cart_items`
+     */
+    overrideCart({ body }?: {
+        body: OverrideCheckoutReq;
+    }): Promise<OverrideCheckoutResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.cartId - Current Cart _id
@@ -285,6 +324,18 @@ declare class Cart {
         b?: boolean;
         body: UpdateCartRequest;
     }): Promise<UpdateCartDetailResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.cartMetaId -
+     * @param {CartMetaConfigUpdate} arg.body
+     * @returns {Promise<CartMetaConfigUpdate>} - Success response
+     * @summary: Update cart meta configuration
+     * @description: Update cart meta configuration
+     */
+    updateCartMetaConfig({ cartMetaId, body }?: {
+        cartMetaId: string;
+        body: CartMetaConfigUpdate;
+    }): Promise<CartMetaConfigUpdate>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id -