@gofynd/fdk-client-javascript 0.1.35

package/sdk/application/client/CartApplicationClient.d.ts

@@ -0,0 +1,432 @@
+export = Cart;
+declare class Cart {
+    constructor(_conf: any);
+    _conf: any;
+    _relativeUrls: {
+        getCart: string;
+        getCartLastModified: string;
+        addItems: string;
+        updateCart: string;
+        getItemCount: string;
+        getCoupons: string;
+        applyCoupon: string;
+        removeCoupon: string;
+        getBulkDiscountOffers: string;
+        applyRewardPoints: string;
+        getAddresses: string;
+        addAddress: string;
+        getAddressById: string;
+        updateAddress: string;
+        removeAddress: string;
+        selectAddress: string;
+        selectPaymentMode: string;
+        validateCouponForPayment: string;
+        getShipments: string;
+        checkoutCart: string;
+        updateCartMeta: string;
+        getCartShareLink: string;
+        getCartSharedItems: string;
+        updateCartWithSharedItems: string;
+        getPromotionOffers: string;
+        getLadderOffers: string;
+    };
+    _urls: {};
+    updateUrls(urls: any): void;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.id] -
+     * @param {boolean} [arg.i] -
+     * @param {boolean} [arg.b] -
+     * @param {number} [arg.assignCardId] -
+     * @param {boolean} [arg.buyNow] -
+     * @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.
+     */
+    getCart({ id, i, b, assignCardId, buyNow }?: {
+        id?: string;
+        i?: boolean;
+        b?: boolean;
+        assignCardId?: number;
+        buyNow?: boolean;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.id] -
+     * @returns {Promise<any>} - Success response
+     * @summary: Fetch last-modified timestamp
+     * @description: Use this API to fetch Last-Modified timestamp in header metadata.
+     */
+    getCartLastModified({ id }?: {
+        id?: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {boolean} [arg.i] -
+     * @param {boolean} [arg.b] -
+     * @param {boolean} [arg.buyNow] -
+     * @param {AddCartRequest} arg.body
+     * @returns {Promise<AddCartDetailResponse>} - Success response
+     * @summary: Add items to cart
+     * @description: Use this API to add items to the cart.
+     */
+    addItems({ body, i, b, buyNow }?: {
+        i?: boolean;
+        b?: boolean;
+        buyNow?: boolean;
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.id] -
+     * @param {boolean} [arg.i] -
+     * @param {boolean} [arg.b] -
+     * @param {boolean} [arg.buyNow] -
+     * @param {UpdateCartRequest} arg.body
+     * @returns {Promise<UpdateCartDetailResponse>} - Success response
+     * @summary: Update items in the 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>
+     */
+    updateCart({ body, id, i, b, buyNow }?: {
+        id?: string;
+        i?: boolean;
+        b?: boolean;
+        buyNow?: boolean;
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.id] - The unique identifier of the cart.
+     * @param {boolean} [arg.buyNow] -
+     * @returns {Promise<CartItemCountResponse>} - Success response
+     * @summary: Count items in the cart
+     * @description: Use this API to get the total number of items present in cart.
+     */
+    getItemCount({ id, buyNow }?: {
+        id?: string;
+        buyNow?: boolean;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.id] -
+     * @param {boolean} [arg.buyNow] -
+     * @returns {Promise<GetCouponResponse>} - Success response
+     * @summary: Fetch Coupon
+     * @description: Use this API to get a list of available coupons along with their details.
+     */
+    getCoupons({ id, buyNow }?: {
+        id?: string;
+        buyNow?: boolean;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {boolean} [arg.i] -
+     * @param {boolean} [arg.b] -
+     * @param {boolean} [arg.p] -
+     * @param {string} [arg.id] -
+     * @param {boolean} [arg.buyNow] -
+     * @param {ApplyCouponRequest} arg.body
+     * @returns {Promise<CartDetailResponse>} - Success response
+     * @summary: Apply Coupon
+     * @description: Use this API to apply coupons on items in the cart.
+     */
+    applyCoupon({ body, i, b, p, id, buyNow }?: {
+        i?: boolean;
+        b?: boolean;
+        p?: boolean;
+        id?: string;
+        buyNow?: boolean;
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.id] -
+     * @param {boolean} [arg.buyNow] -
+     * @returns {Promise<CartDetailResponse>} - Success response
+     * @summary: Remove Coupon Applied
+     * @description: Remove Coupon applied on the cart by passing uid in request body.
+     */
+    removeCoupon({ id, buyNow }?: {
+        id?: string;
+        buyNow?: boolean;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.itemId] - The Item ID of the product
+     * @param {string} [arg.articleId] - Article Mongo ID
+     * @param {number} [arg.uid] - UID of the product
+     * @param {string} [arg.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/
+     * @returns {Promise<BulkPriceResponse>} - Success response
+     * @summary: Get discount offers based on quantity
+     * @description: Use this API to get a list of applicable offers along with current, next and best offer for given product. Either one of uid, item_id, slug should be present.
+     */
+    getBulkDiscountOffers({ itemId, articleId, uid, slug }?: {
+        itemId?: number;
+        articleId?: string;
+        uid?: number;
+        slug?: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.id] -
+     * @param {boolean} [arg.i] -
+     * @param {boolean} [arg.b] -
+     * @param {boolean} [arg.buyNow] -
+     * @param {RewardPointRequest} arg.body
+     * @returns {Promise<CartDetailResponse>} - Success response
+     * @summary: Apply reward points at cart
+     * @description: Use this API to redeem a fixed no. of reward points by applying it to the cart.
+     */
+    applyRewardPoints({ body, id, i, b, buyNow }?: {
+        id?: string;
+        i?: boolean;
+        b?: boolean;
+        buyNow?: boolean;
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.cartId] -
+     * @param {boolean} [arg.buyNow] -
+     * @param {string} [arg.mobileNo] -
+     * @param {string} [arg.checkoutMode] -
+     * @param {string} [arg.tags] -
+     * @param {boolean} [arg.isDefault] -
+     * @returns {Promise<GetAddressesResponse>} - Success response
+     * @summary: Fetch address
+     * @description: Use this API to get all the addresses associated with an account. If successful, returns a Address resource in the response body specified in GetAddressesResponse.attibutes listed below are optional <ul> <li> <font color="monochrome">uid</font></li> <li> <font color="monochrome">address_id</font></li> <li> <font color="monochrome">mobile_no</font></li> <li> <font color="monochrome">checkout_mode</font></li> <li> <font color="monochrome">tags</font></li> <li> <font color="monochrome">default</font></li> </ul>
+     */
+    getAddresses({ cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, }?: {
+        cartId?: string;
+        buyNow?: boolean;
+        mobileNo?: string;
+        checkoutMode?: string;
+        tags?: string;
+        isDefault?: boolean;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {Address} arg.body
+     * @returns {Promise<SaveAddressResponse>} - Success response
+     * @summary: Add address to an account
+     * @description: Use this API to add an address to an account.
+     */
+    addAddress({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id -
+     * @param {string} [arg.cartId] -
+     * @param {boolean} [arg.buyNow] -
+     * @param {string} [arg.mobileNo] -
+     * @param {string} [arg.checkoutMode] -
+     * @param {string} [arg.tags] -
+     * @param {boolean} [arg.isDefault] -
+     * @returns {Promise<Address>} - Success response
+     * @summary: Fetch a single address by its ID
+     * @description: Use this API to get an addresses using its ID. If successful, returns a Address resource in the response body specified in `Address`. Attibutes listed below are optional <ul> <li> <font color="monochrome">mobile_no</font></li> <li> <font color="monochrome">checkout_mode</font></li> <li> <font color="monochrome">tags</font></li> <li> <font color="monochrome">default</font></li> </ul>
+     */
+    getAddressById({ id, cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, }?: {
+        id: string;
+        cartId?: string;
+        buyNow?: boolean;
+        mobileNo?: string;
+        checkoutMode?: string;
+        tags?: string;
+        isDefault?: boolean;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - ID allotted to the selected address
+     * @param {Address} arg.body
+     * @returns {Promise<UpdateAddressResponse>} - Success response
+     * @summary: Update address added to an account
+     * @description: <p>Use this API to update an existing address in the account. Request object should contain attributes mentioned in  <font color="blue">Address </font> can be updated. These attributes are:</p> <ul> <li> <font color="monochrome">is_default_address</font></li> <li> <font color="monochrome">landmark</font></li> <li> <font color="monochrome">area</font></li> <li> <font color="monochrome">pincode</font></li> <li> <font color="monochrome">email</font></li> <li> <font color="monochrome">address_type</font></li> <li> <font color="monochrome">name</font></li> <li> <font color="monochrome">address_id</font></li> <li> <font color="monochrome">address</font></li> </ul>
+     */
+    updateAddress({ id, body }?: {
+        id: string;
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - ID allotted to the selected address
+     * @returns {Promise<DeleteAddressResponse>} - Success response
+     * @summary: Remove address associated with an account
+     * @description: Use this API to delete an address by its ID. This will returns an object that will indicate whether the address was deleted successfully or not.
+     */
+    removeAddress({ id }?: {
+        id: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.cartId] -
+     * @param {boolean} [arg.buyNow] -
+     * @param {boolean} [arg.i] -
+     * @param {boolean} [arg.b] -
+     * @param {SelectCartAddressRequest} arg.body
+     * @returns {Promise<CartDetailResponse>} - Success response
+     * @summary: Select an address from available addresses
+     * @description: <p>Select Address from all addresses associated with the account in order to ship the cart items to that address, otherwise default address will be selected implicitly. See `SelectCartAddressRequest` in schema of request body for the list of attributes needed to select Address from account. On successful request, this API returns a Cart object. Below address attributes are required. <ul> <li> <font color="monochrome">address_id</font></li> <li> <font color="monochrome">billing_address_id</font></li> <li> <font color="monochrome">uid</font></li> </ul></p>
+     */
+    selectAddress({ body, cartId, buyNow, i, b }?: {
+        cartId?: string;
+        buyNow?: boolean;
+        i?: boolean;
+        b?: boolean;
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.id] -
+     * @param {boolean} [arg.buyNow] -
+     * @param {UpdateCartPaymentRequest} arg.body
+     * @returns {Promise<CartDetailResponse>} - Success response
+     * @summary: Update cart payment
+     * @description: Use this API to update cart payment.
+     */
+    selectPaymentMode({ body, id, buyNow }?: {
+        id?: string;
+        buyNow?: boolean;
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.id] -
+     * @param {boolean} [arg.buyNow] -
+     * @param {string} [arg.addressId] -
+     * @param {string} [arg.paymentMode] -
+     * @param {string} [arg.paymentIdentifier] -
+     * @param {string} [arg.aggregatorName] -
+     * @param {string} [arg.merchantCode] -
+     * @returns {Promise<PaymentCouponValidate>} - Success response
+     * @summary: Verify the coupon eligibility against the payment mode
+     * @description: Use this API to validate a coupon against the payment mode such as NetBanking, Wallet, UPI etc.
+     */
+    validateCouponForPayment({ id, buyNow, addressId, paymentMode, paymentIdentifier, aggregatorName, merchantCode, }?: {
+        id?: string;
+        buyNow?: boolean;
+        addressId?: string;
+        paymentMode?: string;
+        paymentIdentifier?: string;
+        aggregatorName?: string;
+        merchantCode?: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {boolean} [arg.p] - This is a boolean value. Select `true` for
+     *   getting a payment option in response.
+     * @param {string} [arg.id] - The unique identifier of the cart
+     * @param {boolean} [arg.buyNow] -
+     * @param {string} [arg.addressId] - ID allotted to the selected address
+     * @param {string} [arg.areaCode] - The PIN Code of the destination address,
+     *   e.g. 400059
+     * @returns {Promise<CartShipmentsResponse>} - Success response
+     * @summary: Get delivery date and options before checkout
+     * @description: Use this API to get shipment details, expected delivery date, items and price breakup of the shipment.
+     */
+    getShipments({ p, id, buyNow, addressId, areaCode }?: {
+        p?: boolean;
+        id?: string;
+        buyNow?: boolean;
+        addressId?: string;
+        areaCode?: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {boolean} [arg.buyNow] - This indicates the type of cart to checkout
+     * @param {CartCheckoutDetailRequest} arg.body
+     * @returns {Promise<CartCheckoutResponse>} - Success response
+     * @summary: Checkout all items in the cart
+     * @description: Use this API to checkout all items in the cart for payment and order generation. For COD, order will be directly generated, whereas for other checkout modes, user will be redirected to a payment gateway.
+     */
+    checkoutCart({ body, buyNow }?: {
+        buyNow?: boolean;
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.id] -
+     * @param {boolean} [arg.buyNow] -
+     * @param {CartMetaRequest} arg.body
+     * @returns {Promise<CartMetaResponse>} - Success response
+     * @summary: Update the cart meta
+     * @description: Use this API to update cart meta like checkout_mode and gstin.
+     */
+    updateCartMeta({ body, id, buyNow }?: {
+        id?: string;
+        buyNow?: boolean;
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {GetShareCartLinkRequest} arg.body
+     * @returns {Promise<GetShareCartLinkResponse>} - Success response
+     * @summary: Generate token for sharing the cart
+     * @description: Use this API to generate a shared cart snapshot and return a shortlink token. The link can be shared with other users for getting the same items in their cart.
+     */
+    getCartShareLink({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.token - Token of the shared short link
+     * @returns {Promise<SharedCartResponse>} - Success response
+     * @summary: Get details of a shared cart
+     * @description: Use this API to get the shared cart details as per the token generated using the share-cart API.
+     */
+    getCartSharedItems({ token }?: {
+        token: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.token - Token of the shared short link
+     * @param {string} arg.action - Operation to perform on the existing cart
+     *   merge or replace.
+     * @returns {Promise<SharedCartResponse>} - Success response
+     * @summary: Merge or replace existing cart
+     * @description: Use this API to merge the shared cart with existing cart, or replace the existing cart with the shared cart. The `action` parameter is used to indicate the operation Merge or Replace.
+     */
+    updateCartWithSharedItems({ token, action }?: {
+        token: string;
+        action: string;
+    }): Promise<any>;
+    /**
+     * @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
+     *   /service/application/catalog/v1.0/products/
+     * @param {number} [arg.pageSize] - Number of offers to be fetched to show
+     * @param {string} [arg.promotionGroup] - Type of promotion groups
+     * @returns {Promise<PromotionOffersResponse>} - Success response
+     * @summary: Fetch available promotions
+     * @description: Use this API to get top 5 offers available for current product
+     */
+    getPromotionOffers({ slug, pageSize, promotionGroup }?: {
+        slug?: string;
+        pageSize?: number;
+        promotionGroup?: string;
+    }): Promise<any>;
+    /**
+     * @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
+     *   /service/application/catalog/v1.0/products/
+     * @param {string} [arg.storeId] - Store uid of assigned store on PDP page.
+     *   If not passed default first created ladder will be returned
+     * @param {string} [arg.promotionId] - Get ladder information of given
+     *   promotion id explicitely
+     * @param {number} [arg.pageSize] - Number of offers to be fetched to show
+     * @returns {Promise<LadderPriceOffers>} - Success response
+     * @summary: Fetch ladder price promotion
+     * @description: Use this API to get applicable ladder price promotion for current product
+     */
+    getLadderOffers({ slug, storeId, promotionId, pageSize }?: {
+        slug: string;
+        storeId?: string;
+        promotionId?: string;
+        pageSize?: number;
+    }): Promise<any>;
+}