@wix/auto_sdk_ecom_cart 1.0.76 → 1.0.78

package/build/cjs/index.d.ts

@@ -20,7 +20,9 @@ interface UpdateCartSignature {
     /**
      * Updates a cart's properties.
      *
-     * > **Note:** When updating line items, the `lineItems.catalogReference.appId` and `lineItems.catalogReference.catalogItemId` fields are required.
+     * > **Notes:**
+     * > + When updating line items, the `lineItems.catalogReference.appId` and `lineItems.catalogReference.catalogItemId` fields are required.
+     * > + After a cart is updated, call [Refresh Cart](https://dev.wix.com/docs/sdk/frontend-modules/ecom/refresh-cart) to update the cart's UI elements and trigger the Cart Updated event.
      * @param - Available options to use when updating a cart.
      * @param - ID of the cart to be updated.
      * @returns Updated Cart.
@@ -43,7 +45,9 @@ interface AddToCartSignature {
     /**
      * Adds catalog ([SDK](https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/e-commerce-integration) | [REST](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)) line items to a cart.
      *
-     * >**Note:** When adding catalog line items to a cart, the `lineItems.catalogReference.appId` and `lineItems.catalogReference.catalogItemId` fields are required.
+     * >**Notes:**
+     * > + When adding catalog line items to a cart, the `lineItems.catalogReference.appId` and `lineItems.catalogReference.catalogItemId` fields are required.
+     * > + After a cart is updated, call [Refresh Cart](https://dev.wix.com/docs/sdk/frontend-modules/ecom/refresh-cart) to update the cart's UI elements and trigger the Cart Updated event.
      * @param - Cart ID.
      * @param - Items to be added to cart.
      */
@@ -55,6 +59,8 @@ declare function removeLineItems$1(httpClient: HttpClient): RemoveLineItemsSigna
 interface RemoveLineItemsSignature {
     /**
      * Removes line items from a cart.
+     *
+     * > **Note:** After a cart is updated, call [Refresh Cart](https://dev.wix.com/docs/sdk/frontend-modules/ecom/refresh-cart) to update the cart's UI elements and trigger the Cart Updated event.
      * @param - IDs of the line items to remove from the cart.
      * @param - ID of the cart to remove line items from.
      */
@@ -80,6 +86,8 @@ declare function removeCoupon$1(httpClient: HttpClient): RemoveCouponSignature;
 interface RemoveCouponSignature {
     /**
      * Removes the coupon from a cart.
+     *
+     * > **Note:** After a cart is updated, call [Refresh Cart](https://dev.wix.com/docs/sdk/frontend-modules/ecom/refresh-cart) to update the cart's UI elements and trigger the Cart Updated event.
      * @param - Cart ID.
      */
     (_id: string): Promise<NonNullablePaths<RemoveCouponResponse, `cart.lineItems` | `cart.lineItems.${number}.quantity` | `cart.lineItems.${number}.catalogReference.catalogItemId` | `cart.lineItems.${number}.catalogReference.appId` | `cart.lineItems.${number}.productName.original` | `cart.lineItems.${number}.price.amount` | `cart.lineItems.${number}.price.convertedAmount` | `cart.lineItems.${number}.price.formattedAmount` | `cart.lineItems.${number}.price.formattedConvertedAmount` | `cart.lineItems.${number}.availability.status` | `cart.lineItems.${number}.physicalProperties.shippable` | `cart.lineItems.${number}.itemType.preset` | `cart.lineItems.${number}.itemType.custom` | `cart.lineItems.${number}.paymentOption` | `cart.lineItems.${number}.priceDescription.original` | `cart.lineItems.${number}.selectedMembership._id` | `cart.lineItems.${number}.selectedMembership.appId` | `cart.lineItems.${number}.customLineItem` | `cart.lineItems.${number}.priceUndetermined` | `cart.lineItems.${number}.fixedQuantity` | `cart.lineItems.${number}.catalogOverrideFields.paymentOption.value` | `cart.lineItems.${number}.savePaymentMethod` | `cart.lineItems.${number}.taxableAddress.addressType` | `cart.lineItems.${number}.membersOnly` | `cart.buyerInfo.visitorId` | `cart.buyerInfo.memberId` | `cart.buyerInfo.userId` | `cart.currency` | `cart.conversionCurrency` | `cart.weightUnit` | `cart.appliedDiscounts` | `cart.appliedDiscounts.${number}.coupon._id` | `cart.appliedDiscounts.${number}.coupon.code` | `cart.contactInfo.address.streetAddress.number` | `cart.contactInfo.address.streetAddress.name` | `cart.contactInfo.contactDetails.vatId._id` | `cart.contactInfo.contactDetails.vatId.type` | `cart.selectedShippingOption.code` | `cart.paymentCurrency`, 7>>;
@@ -87,7 +95,7 @@ interface RemoveCouponSignature {
 declare function updateLineItemsQuantity$1(httpClient: HttpClient): UpdateLineItemsQuantitySignature;
 interface UpdateLineItemsQuantitySignature {
     /**
-     * Updates the quantity of one or more line items in a cart.
+     * Updates the quantity of 1 or more line items in a cart.
      *
      * This method is only for updating the quantity of line items.
      * To entirely remove a line item from the cart, use Remove Line Items.
@@ -96,6 +104,8 @@ interface UpdateLineItemsQuantitySignature {
      * This method checks the amount of stock remaining for this line item.
      * If the specified quantity is greater than the remaining stock,
      * then the quantity returned in the response is the total amount of remaining stock.
+     *
+     * > **Note:** After a cart is updated, call [Refresh Cart](https://dev.wix.com/docs/sdk/frontend-modules/ecom/refresh-cart) to update the cart's UI elements and trigger the Cart Updated event.
      * @param - Cart ID.
      * @param - Line item IDs and their new quantity.
      */