@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/application/PosCart/PosCartApplicationValidator.js

@@ -1,13 +1,235 @@
 const Joi = require("joi");
 
-const PosCartModel = require("./PosCartApplicationModel");
-class PosCartValidator {
+const PosCartApplicationModel = require("./PosCartApplicationModel");
+
+/**
+ * @typedef AddAddressParam
+ * @property {PosCartApplicationModel.Address} body
+ */
+
+/**
+ * @typedef AddItemsParam
+ * @property {boolean} [i]
+ * @property {boolean} [b]
+ * @property {string} [areaCode]
+ * @property {boolean} [buyNow]
+ * @property {string} [id]
+ * @property {PosCartApplicationModel.AddCartRequest} body
+ */
+
+/**
+ * @typedef ApplyCouponParam
+ * @property {boolean} [i]
+ * @property {boolean} [b]
+ * @property {boolean} [p]
+ * @property {string} [id]
+ * @property {boolean} [buyNow]
+ * @property {PosCartApplicationModel.ApplyCouponRequest} body
+ */
+
+/**
+ * @typedef ApplyRewardPointsParam
+ * @property {string} [id]
+ * @property {boolean} [i]
+ * @property {boolean} [b]
+ * @property {boolean} [buyNow]
+ * @property {PosCartApplicationModel.RewardPointRequest} body
+ */
+
+/**
+ * @typedef CheckoutCartParam
+ * @property {string} [id]
+ * @property {PosCartApplicationModel.CartPosCheckoutDetailRequest} body
+ */
+
+/**
+ * @typedef GetAddressByIdParam
+ * @property {string} id
+ * @property {string} [cartId]
+ * @property {boolean} [buyNow]
+ * @property {string} [mobileNo]
+ * @property {string} [checkoutMode]
+ * @property {string} [tags]
+ * @property {boolean} [isDefault]
+ */
+
+/**
+ * @typedef GetAddressesParam
+ * @property {string} [cartId]
+ * @property {boolean} [buyNow]
+ * @property {string} [mobileNo]
+ * @property {string} [checkoutMode]
+ * @property {string} [tags]
+ * @property {boolean} [isDefault]
+ */
+
+/**
+ * @typedef GetAvailableDeliveryModesParam
+ * @property {string} areaCode
+ * @property {string} [id]
+ */
+
+/**
+ * @typedef GetBulkDiscountOffersParam
+ * @property {number} [itemId] - The Item ID of the product
+ * @property {string} [articleId] - Article Mongo ID
+ * @property {number} [uid] - UID of the product
+ * @property {string} [slug] - A short, human-readable, URL-friendly identifier
+ *   of a product. You can get slug value from the endpoint
+ *   /service/application/catalog/v1.0/products/
+ */
+
+/**
+ * @typedef GetCartParam
+ * @property {string} [id]
+ * @property {boolean} [i]
+ * @property {boolean} [b]
+ * @property {number} [assignCardId]
+ * @property {string} [areaCode]
+ * @property {boolean} [buyNow]
+ */
+
+/**
+ * @typedef GetCartLastModifiedParam
+ * @property {string} [id]
+ */
+
+/**
+ * @typedef GetCartShareLinkParam
+ * @property {PosCartApplicationModel.GetShareCartLinkRequest} body
+ */
+
+/**
+ * @typedef GetCartSharedItemsParam
+ * @property {string} token - Token of the shared short link
+ */
+
+/**
+ * @typedef GetCouponsParam
+ * @property {string} [id]
+ * @property {boolean} [buyNow]
+ */
+
+/**
+ * @typedef GetItemCountParam
+ * @property {string} [id] - The unique identifier of the cart.
+ * @property {boolean} [buyNow]
+ */
+
+/**
+ * @typedef GetShipmentsParam
+ * @property {number} [pickAtStoreUid]
+ * @property {number} [orderingStoreId]
+ * @property {boolean} [p] - This is a boolean value. Select `true` for getting
+ *   a payment option in response.
+ * @property {string} [id] - The unique identifier of the cart
+ * @property {string} [addressId] - ID allotted to the selected address
+ * @property {string} [areaCode] - The PIN Code of the destination address, e.g. 400059
+ * @property {string} [orderType] - The order type of shipment HomeDelivery - If
+ *   the customer wants the order home-delivered PickAtStore - If the customer
+ *   wants the handover of an order at the store itself.
+ */
+
+/**
+ * @typedef GetStoreAddressByUidParam
+ * @property {number} storeUid
+ */
+
+/**
+ * @typedef RemoveAddressParam
+ * @property {string} id - ID allotted to the selected address
+ */
+
+/**
+ * @typedef RemoveCouponParam
+ * @property {string} [id]
+ * @property {boolean} [buyNow]
+ */
+
+/**
+ * @typedef SelectAddressParam
+ * @property {string} [cartId]
+ * @property {boolean} [buyNow]
+ * @property {boolean} [i]
+ * @property {boolean} [b]
+ * @property {PosCartApplicationModel.SelectCartAddressRequest} body
+ */
+
+/**
+ * @typedef SelectPaymentModeParam
+ * @property {string} [id]
+ * @property {boolean} [buyNow]
+ * @property {PosCartApplicationModel.UpdateCartPaymentRequest} body
+ */
+
+/**
+ * @typedef UpdateAddressParam
+ * @property {string} id - ID allotted to the selected address
+ * @property {PosCartApplicationModel.Address} body
+ */
+
+/**
+ * @typedef UpdateCartParam
+ * @property {string} [id]
+ * @property {boolean} [i]
+ * @property {boolean} [b]
+ * @property {string} [areaCode]
+ * @property {boolean} [buyNow]
+ * @property {PosCartApplicationModel.UpdateCartRequest} body
+ */
+
+/**
+ * @typedef UpdateCartMetaParam
+ * @property {string} [id]
+ * @property {boolean} [buyNow]
+ * @property {PosCartApplicationModel.CartMetaRequest} body
+ */
+
+/**
+ * @typedef UpdateCartWithSharedItemsParam
+ * @property {string} token - Token of the shared short link
+ * @property {string} action - Operation to perform on the existing cart merge or replace.
+ */
+
+/**
+ * @typedef UpdateShipmentsParam
+ * @property {boolean} [i] - This is a boolean value. Select `true` to retrieve
+ *   all the items added in the cart.
+ * @property {boolean} [p] - This is a boolean value. Select `true` for getting
+ *   a payment option in response.
+ * @property {string} [id] - The unique identifier of the cart
+ * @property {string} [addressId] - ID allotted to an address
+ * @property {string} [areaCode] - The PIN Code of the destination address, e.g. 400059
+ * @property {string} [orderType] - The order type of shipment HomeDelivery - If
+ *   the customer wants the order home-delivered PickAtStore - If the customer
+ *   wants the handover of an order at the store itself.
+ * @property {PosCartApplicationModel.UpdateCartShipmentRequest} body
+ */
+
+/**
+ * @typedef ValidateCouponForPaymentParam
+ * @property {string} [id]
+ * @property {boolean} [buyNow]
+ * @property {string} [addressId]
+ * @property {string} [paymentMode]
+ * @property {string} [paymentIdentifier]
+ * @property {string} [aggregatorName]
+ * @property {string} [merchantCode]
+ * @property {string} [iin]
+ * @property {string} [network]
+ * @property {string} [type]
+ * @property {string} [cardId]
+ */
+
+class PosCartApplicationValidator {
+  /** @returns {AddAddressParam} */
   static addAddress() {
     return Joi.object({
-      body: PosCartModel.Address().required(),
+      body: PosCartApplicationModel.Address().required(),
     }).required();
   }
 
+  /** @returns {AddItemsParam} */
   static addItems() {
     return Joi.object({
       i: Joi.boolean(),
@@ -15,10 +237,11 @@ class PosCartValidator {
       areaCode: Joi.string().allow(""),
       buyNow: Joi.boolean(),
       id: Joi.string().allow(""),
-      body: PosCartModel.AddCartRequest().required(),
+      body: PosCartApplicationModel.AddCartRequest().required(),
     }).required();
   }
 
+  /** @returns {ApplyCouponParam} */
   static applyCoupon() {
     return Joi.object({
       i: Joi.boolean(),
@@ -26,27 +249,30 @@ class PosCartValidator {
       p: Joi.boolean(),
       id: Joi.string().allow(""),
       buyNow: Joi.boolean(),
-      body: PosCartModel.ApplyCouponRequest().required(),
+      body: PosCartApplicationModel.ApplyCouponRequest().required(),
     }).required();
   }
 
+  /** @returns {ApplyRewardPointsParam} */
   static applyRewardPoints() {
     return Joi.object({
       id: Joi.string().allow(""),
       i: Joi.boolean(),
       b: Joi.boolean(),
       buyNow: Joi.boolean(),
-      body: PosCartModel.RewardPointRequest().required(),
+      body: PosCartApplicationModel.RewardPointRequest().required(),
     }).required();
   }
 
+  /** @returns {CheckoutCartParam} */
   static checkoutCart() {
     return Joi.object({
       id: Joi.string().allow(""),
-      body: PosCartModel.CartPosCheckoutDetailRequest().required(),
+      body: PosCartApplicationModel.CartPosCheckoutDetailRequest().required(),
     }).required();
   }
 
+  /** @returns {GetAddressByIdParam} */
   static getAddressById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
@@ -59,6 +285,7 @@ class PosCartValidator {
     }).required();
   }
 
+  /** @returns {GetAddressesParam} */
   static getAddresses() {
     return Joi.object({
       cartId: Joi.string().allow(""),
@@ -70,6 +297,7 @@ class PosCartValidator {
     });
   }
 
+  /** @returns {GetAvailableDeliveryModesParam} */
   static getAvailableDeliveryModes() {
     return Joi.object({
       areaCode: Joi.string().allow("").required(),
@@ -77,6 +305,7 @@ class PosCartValidator {
     }).required();
   }
 
+  /** @returns {GetBulkDiscountOffersParam} */
   static getBulkDiscountOffers() {
     return Joi.object({
       itemId: Joi.number(),
@@ -86,6 +315,7 @@ class PosCartValidator {
     });
   }
 
+  /** @returns {GetCartParam} */
   static getCart() {
     return Joi.object({
       id: Joi.string().allow(""),
@@ -97,24 +327,28 @@ class PosCartValidator {
     });
   }
 
+  /** @returns {GetCartLastModifiedParam} */
   static getCartLastModified() {
     return Joi.object({
       id: Joi.string().allow(""),
     });
   }
 
+  /** @returns {GetCartShareLinkParam} */
   static getCartShareLink() {
     return Joi.object({
-      body: PosCartModel.GetShareCartLinkRequest().required(),
+      body: PosCartApplicationModel.GetShareCartLinkRequest().required(),
     }).required();
   }
 
+  /** @returns {GetCartSharedItemsParam} */
   static getCartSharedItems() {
     return Joi.object({
       token: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetCouponsParam} */
   static getCoupons() {
     return Joi.object({
       id: Joi.string().allow(""),
@@ -122,6 +356,7 @@ class PosCartValidator {
     });
   }
 
+  /** @returns {GetItemCountParam} */
   static getItemCount() {
     return Joi.object({
       id: Joi.string().allow(""),
@@ -129,6 +364,7 @@ class PosCartValidator {
     });
   }
 
+  /** @returns {GetShipmentsParam} */
   static getShipments() {
     return Joi.object({
       pickAtStoreUid: Joi.number(),
@@ -141,18 +377,21 @@ class PosCartValidator {
     });
   }
 
+  /** @returns {GetStoreAddressByUidParam} */
   static getStoreAddressByUid() {
     return Joi.object({
       storeUid: Joi.number().required(),
     }).required();
   }
 
+  /** @returns {RemoveAddressParam} */
   static removeAddress() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {RemoveCouponParam} */
   static removeCoupon() {
     return Joi.object({
       id: Joi.string().allow(""),
@@ -160,31 +399,35 @@ class PosCartValidator {
     });
   }
 
+  /** @returns {SelectAddressParam} */
   static selectAddress() {
     return Joi.object({
       cartId: Joi.string().allow(""),
       buyNow: Joi.boolean(),
       i: Joi.boolean(),
       b: Joi.boolean(),
-      body: PosCartModel.SelectCartAddressRequest().required(),
+      body: PosCartApplicationModel.SelectCartAddressRequest().required(),
     }).required();
   }
 
+  /** @returns {SelectPaymentModeParam} */
   static selectPaymentMode() {
     return Joi.object({
       id: Joi.string().allow(""),
       buyNow: Joi.boolean(),
-      body: PosCartModel.UpdateCartPaymentRequest().required(),
+      body: PosCartApplicationModel.UpdateCartPaymentRequest().required(),
     }).required();
   }
 
+  /** @returns {UpdateAddressParam} */
   static updateAddress() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: PosCartModel.Address().required(),
+      body: PosCartApplicationModel.Address().required(),
     }).required();
   }
 
+  /** @returns {UpdateCartParam} */
   static updateCart() {
     return Joi.object({
       id: Joi.string().allow(""),
@@ -192,18 +435,20 @@ class PosCartValidator {
       b: Joi.boolean(),
       areaCode: Joi.string().allow(""),
       buyNow: Joi.boolean(),
-      body: PosCartModel.UpdateCartRequest().required(),
+      body: PosCartApplicationModel.UpdateCartRequest().required(),
     }).required();
   }
 
+  /** @returns {UpdateCartMetaParam} */
   static updateCartMeta() {
     return Joi.object({
       id: Joi.string().allow(""),
       buyNow: Joi.boolean(),
-      body: PosCartModel.CartMetaRequest().required(),
+      body: PosCartApplicationModel.CartMetaRequest().required(),
     }).required();
   }
 
+  /** @returns {UpdateCartWithSharedItemsParam} */
   static updateCartWithSharedItems() {
     return Joi.object({
       token: Joi.string().allow("").required(),
@@ -211,6 +456,7 @@ class PosCartValidator {
     }).required();
   }
 
+  /** @returns {UpdateShipmentsParam} */
   static updateShipments() {
     return Joi.object({
       i: Joi.boolean(),
@@ -219,10 +465,11 @@ class PosCartValidator {
       addressId: Joi.string().allow(""),
       areaCode: Joi.string().allow(""),
       orderType: Joi.string().allow(""),
-      body: PosCartModel.UpdateCartShipmentRequest().required(),
+      body: PosCartApplicationModel.UpdateCartShipmentRequest().required(),
     }).required();
   }
 
+  /** @returns {ValidateCouponForPaymentParam} */
   static validateCouponForPayment() {
     return Joi.object({
       id: Joi.string().allow(""),
@@ -240,4 +487,4 @@ class PosCartValidator {
   }
 }
 
-module.exports = PosCartValidator;
+module.exports = PosCartApplicationValidator;

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

@@ -14,80 +14,82 @@ declare class Rewards {
     _urls: {};
     updateUrls(urls: any): void;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {CatalogueOrderRequest} arg.body
-     * @returns {Promise<CatalogueOrderResponse>} - Success response
+     * @param {RewardsApplicationValidator.CatalogueOrderParam} arg - Arg object.
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<RewardsApplicationModel.CatalogueOrderResponse>} -
+     *   Success response
+     * @name catalogueOrder
      * @summary: Get all transactions of reward points
-     * @description: Use this API to evaluate the amount of reward points that could be earned on any catalogue product.
+     * @description: Use this API to evaluate the amount of reward points that could be earned on any catalogue product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/catalogueOrder/).
      */
-    catalogueOrder({ body }?: {
-        body: CatalogueOrderRequest;
-    }): Promise<CatalogueOrderResponse>;
+    catalogueOrder({ body }?: RewardsApplicationValidator.CatalogueOrderParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<RewardsApplicationModel.CatalogueOrderResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.name - The name given to the offer.
-     * @returns {Promise<Offer>} - Success response
+     * @param {RewardsApplicationValidator.GetOfferByNameParam} arg - Arg object.
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<RewardsApplicationModel.Offer>} - Success response
+     * @name getOfferByName
      * @summary: Get offer by name
-     * @description: Use this API to get fetch the specific offer details and configuration by the name of the offer.
+     * @description: Use this API to get fetch the specific offer details and configuration by the name of the offer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getOfferByName/).
      */
-    getOfferByName({ name }?: {
-        name: string;
-    }): Promise<Offer>;
+    getOfferByName({ name }?: RewardsApplicationValidator.GetOfferByNameParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<RewardsApplicationModel.Offer>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {OrderDiscountRequest} arg.body
-     * @returns {Promise<OrderDiscountResponse>} - Success response
+     * @param {RewardsApplicationValidator.GetOrderDiscountParam} arg - Arg object.
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<RewardsApplicationModel.OrderDiscountResponse>} -
+     *   Success response
+     * @name getOrderDiscount
      * @summary: Calculates the discount on order-amount
-     * @description: Use this API to calculate the discount on the order amount, based on all the amount range configured in Order Discount offer.
+     * @description: Use this API to calculate the discount on the order amount, based on all the amount range configured in Order Discount offer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getOrderDiscount/).
      */
-    getOrderDiscount({ body }?: {
-        body: OrderDiscountRequest;
-    }): Promise<OrderDiscountResponse>;
+    getOrderDiscount({ body }?: RewardsApplicationValidator.GetOrderDiscountParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<RewardsApplicationModel.OrderDiscountResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<PointsResponse>} - Success response
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<RewardsApplicationModel.PointsResponse>} - Success response
+     * @name getUserPoints
      * @summary: Get total available points of a user
-     * @description: Use this API to retrieve total available points of a user for current application.
+     * @description: Use this API to retrieve total available points of a user for current application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getUserPoints/).
      */
-    getUserPoints({}?: any): Promise<PointsResponse>;
+    getUserPoints({ headers }?: import("../ApplicationAPIClient").Options): Promise<RewardsApplicationModel.PointsResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} [arg.pageId] - PageID is the ID of the requested page.
-     *   For first request it should be kept empty.
-     * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
-     * @returns {Promise<PointsHistoryResponse>} - Success response
+     * @param {RewardsApplicationValidator.GetUserPointsHistoryParam} arg - Arg object.
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<RewardsApplicationModel.PointsHistoryResponse>} -
+     *   Success response
+     * @name getUserPointsHistory
      * @summary: Get all transactions of reward points
-     * @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.
+     * @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. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getUserPointsHistory/).
      */
-    getUserPointsHistory({ pageId, pageSize }?: {
-        pageId?: string;
-        pageSize?: number;
-    }): Promise<PointsHistoryResponse>;
+    getUserPointsHistory({ pageId, pageSize }?: RewardsApplicationValidator.GetUserPointsHistoryParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<RewardsApplicationModel.PointsHistoryResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
+     * @returns {Paginator<RewardsApplicationModel.PointsHistoryResponse>}
      * @summary: Get all transactions of reward points
      * @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;
-    }): Paginator;
+    }): Paginator<RewardsApplicationModel.PointsHistoryResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<ReferralDetailsResponse>} - Success response
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<RewardsApplicationModel.ReferralDetailsResponse>} -
+     *   Success response
+     * @name getUserReferralDetails
      * @summary: Get referral details of a user
-     * @description: Use this API to retrieve the referral details like referral code of a user.
+     * @description: Use this API to retrieve the referral details like referral code of a user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/getUserReferralDetails/).
      */
-    getUserReferralDetails({}?: any): Promise<ReferralDetailsResponse>;
+    getUserReferralDetails({ headers }?: import("../ApplicationAPIClient").Options): Promise<RewardsApplicationModel.ReferralDetailsResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {RedeemReferralCodeRequest} arg.body
-     * @returns {Promise<RedeemReferralCodeResponse>} - Success response
+     * @param {RewardsApplicationValidator.RedeemReferralCodeParam} arg - Arg object.
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<RewardsApplicationModel.RedeemReferralCodeResponse>} -
+     *   Success response
+     * @name redeemReferralCode
      * @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.
+     * @description: Use this API to enter a referral code following which, the configured points would be credited to a user's reward points account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/rewards/redeemReferralCode/).
      */
-    redeemReferralCode({ body }?: {
-        body: RedeemReferralCodeRequest;
-    }): Promise<RedeemReferralCodeResponse>;
+    redeemReferralCode({ body }?: RewardsApplicationValidator.RedeemReferralCodeParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<RewardsApplicationModel.RedeemReferralCodeResponse>;
 }
+import RewardsApplicationValidator = require("./RewardsApplicationValidator");
+import RewardsApplicationModel = require("./RewardsApplicationModel");
 import Paginator = require("../../common/Paginator");