@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

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

@@ -13,6 +13,7 @@ declare class Cart {
      * @param {boolean} [arg.isDisplay] -
      * @param {string} [arg.typeSlug] -
      * @param {string} [arg.code] -
+     * @returns {Promise<CouponsResponse>} - Success response
      * @summary: Get with single coupon details or coupon list
      * @description: Get coupon list with pagination
      */
@@ -25,7 +26,7 @@ declare class Cart {
         isDisplay?: boolean;
         typeSlug?: string;
         code?: string;
-    }): Promise<any>;
+    }): Promise<CouponsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Current company id
@@ -54,43 +55,47 @@ declare class Cart {
     /**
      * @param {Object} arg - Arg object.
      * @param {CouponAdd} arg.body
+     * @returns {Promise<SuccessMessage>} - Success response
      * @summary: Create new coupon
      * @description: Create new coupon
      */
     createCoupon({ body }?: {
         body: CouponAdd;
-    }): Promise<any>;
+    }): Promise<SuccessMessage>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id -
+     * @returns {Promise<CouponUpdate>} - Success response
      * @summary: Get with single coupon details or coupon list
      * @description: Get single coupon details with `id` in path param
      */
     getCouponById({ id }?: {
         id: string;
-    }): Promise<any>;
+    }): Promise<CouponUpdate>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id -
      * @param {CouponUpdate} arg.body
+     * @returns {Promise<SuccessMessage>} - Success response
      * @summary: Update existing coupon configuration
      * @description: Update coupon with id sent in `id`
      */
     updateCoupon({ id, body }?: {
         id: string;
         body: CouponUpdate;
-    }): Promise<any>;
+    }): Promise<SuccessMessage>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id -
      * @param {CouponPartialUpdate} arg.body
+     * @returns {Promise<SuccessMessage>} - Success response
      * @summary: Update coupon archive state and schedule
      * @description: Update archive/unarchive and change schedule for coupon
      */
     updateCouponPartially({ id, body }?: {
         id: string;
         body: CouponPartialUpdate;
-    }): Promise<any>;
+    }): Promise<SuccessMessage>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] -
@@ -101,6 +106,7 @@ declare class Cart {
      * @param {string} [arg.promotionType] -
      * @param {string} [arg.fpPanel] -
      * @param {string} [arg.promotionId] -
+     * @returns {Promise<PromotionsResponse>} - Success response
      * @summary: Get promotion list
      * @description: Get promotion list with pagination
      */
@@ -113,7 +119,7 @@ declare class Cart {
         promotionType?: string;
         fpPanel?: string;
         promotionId?: string;
-    }): Promise<any>;
+    }): Promise<PromotionsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Current company id
@@ -142,70 +148,77 @@ declare class Cart {
     /**
      * @param {Object} arg - Arg object.
      * @param {PromotionAdd} arg.body
+     * @returns {Promise<PromotionAdd>} - Success response
      * @summary: Create new promotion
      * @description: Create new promotion
      */
     createPromotion({ body }?: {
         body: PromotionAdd;
-    }): Promise<any>;
+    }): Promise<PromotionAdd>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id -
+     * @returns {Promise<PromotionUpdate>} - Success response
      * @summary: Get with single promotion details or promotion list
      * @description: Get single promotion details with `id` in path param
      */
     getPromotionById({ id }?: {
         id: string;
-    }): Promise<any>;
+    }): Promise<PromotionUpdate>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id -
      * @param {PromotionUpdate} arg.body
+     * @returns {Promise<PromotionUpdate>} - Success response
      * @summary: Update existing promotion configuration
      * @description: Update promotion with id sent in `id`
      */
     updatePromotion({ id, body }?: {
         id: string;
         body: PromotionUpdate;
-    }): Promise<any>;
+    }): Promise<PromotionUpdate>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id -
      * @param {PromotionPartialUpdate} arg.body
+     * @returns {Promise<SuccessMessage>} - Success response
      * @summary: Update promotion publish state and schedule
      * @description: Update publish/unpublish and change schedule for promotion
      */
     updatePromotionPartially({ id, body }?: {
         id: string;
         body: PromotionPartialUpdate;
-    }): Promise<any>;
+    }): Promise<SuccessMessage>;
     /**
      * @param {Object} arg - Arg object.
      * @param {OpenapiCartDetailsRequest} arg.body
+     * @returns {Promise<OpenapiCartDetailsResponse>} - Success response
      * @summary: Fetch Cart Details
      * @description: Get all the details of cart for a list of provided `cart_items`
      */
     fetchAndvalidateCartItems({ body }?: {
         body: OpenapiCartDetailsRequest;
-    }): Promise<any>;
+    }): Promise<OpenapiCartDetailsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {OpenApiCartServiceabilityRequest} arg.body
+     * @returns {Promise<OpenApiCartServiceabilityResponse>} - Success response
      * @summary: Check Pincode Serviceability
      * @description: Check Pincode serviceability for cart items provided in `cart_items` and address pincode in `shipping_address`
      */
     checkCartServiceability({ body }?: {
         body: OpenApiCartServiceabilityRequest;
-    }): Promise<any>;
+    }): Promise<OpenApiCartServiceabilityResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {OpenApiPlatformCheckoutReq} arg.body
+     * @returns {Promise<OpenApiCheckoutResponse>} - Success response
      * @summary: Create Fynd order with cart details
      * @description: Generate Fynd order for cart details send with provided `cart_items`
      */
     checkoutCart({ body }?: {
         body: OpenApiPlatformCheckoutReq;
-    }): Promise<any>;
+    }): Promise<OpenApiCheckoutResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] -
@@ -215,6 +228,7 @@ declare class Cart {
      * @param {boolean} [arg.anonymousCart] -
      * @param {string} [arg.lastId] -
      * @param {string} [arg.sortOn] -
+     * @returns {Promise<AbandonedCartResponse>} - Success response
      * @summary: Get with abandoned cart list
      * @description: Get abandoned cart list with pagination
      */
@@ -226,7 +240,7 @@ declare class Cart {
         anonymousCart?: boolean;
         lastId?: string;
         sortOn?: string;
-    }): Promise<any>;
+    }): Promise<AbandonedCartResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Current company id
@@ -255,6 +269,7 @@ declare class Cart {
      * @param {string} [arg.id] -
      * @param {boolean} [arg.i] -
      * @param {boolean} [arg.b] -
+     * @returns {Promise<CartDetailResponse>} - Success response
      * @summary: Fetch all items added to the cart
      * @description: Use this API to get details of all the items added to a cart.
      */
@@ -262,12 +277,13 @@ declare class Cart {
         id?: string;
         i?: boolean;
         b?: boolean;
-    }): Promise<any>;
+    }): Promise<CartDetailResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.cartId - Current Cart _id
      * @param {boolean} [arg.b] -
      * @param {AddCartRequest} arg.body
+     * @returns {Promise<AddCartDetailResponse>} - Success response
      * @summary: Add items to abandoned cart
      * @description: Use this API to add items to the abandoned cart.
      */
@@ -275,12 +291,13 @@ declare class Cart {
         cartId: string;
         b?: boolean;
         body: AddCartRequest;
-    }): Promise<any>;
+    }): Promise<AddCartDetailResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.cartId - Current Cart _id
      * @param {boolean} [arg.b] -
      * @param {UpdateCartRequest} arg.body
+     * @returns {Promise<UpdateCartDetailResponse>} - Success response
      * @summary: Update items in the abandoned cart
      * @description: <p>Use this API to update items added to the cart with the help of a request object containing attributes like item_quantity and item_size. These attributes will be fetched from the following APIs</p> <ul> <li><font color="monochrome">operation</font> Operation for current api call. <b>update_item</b> for update items. <b>remove_item</b> for removing items.</li> <li> <font color="monochrome">item_id</font>  "/platform/content/v1/products/"</li> <li> <font color="monochrome">item_size</font>   "/platform/content/v1/products/:slug/sizes/"</li> <li> <font color="monochrome">quantity</font>  item quantity (must be greater than or equal to 1)</li> <li> <font color="monochrome">article_id</font>   "/content​/v1​/products​/:identifier​/sizes​/price​/"</li> <li> <font color="monochrome">item_index</font>  item position in the cart (must be greater than or equal to 0)</li> </ul>
      */
@@ -288,6 +305,6 @@ declare class Cart {
         cartId: string;
         b?: boolean;
         body: UpdateCartRequest;
-    }): Promise<any>;
+    }): Promise<UpdateCartDetailResponse>;
 }
 import Paginator = require("../../common/Paginator");