@wix/auto_sdk_ecom_current-cart-v-2 1.0.40 → 1.0.42

package/build/internal/es/index.typings.d.mts

@@ -3983,7 +3983,7 @@ interface HeadersEntry {
 }
 /**
  * Creates the Current Cart of the customer.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField options.catalogItems.catalogReference
  * @requiredField options.catalogItems.quantity
@@ -4033,7 +4033,7 @@ interface CreateCurrentCartOptions {
 }
 /**
  * Retrieves the Current Cart of the customer.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @permissionId ecom:v2:cart:get_cart
  * @applicableIdentity APP
@@ -4046,7 +4046,7 @@ declare function getCurrentCart(): Promise<NonNullablePaths<GetCurrentCartRespon
  * Use this endpoint to set and replace fields such as buyer note and delivery method.
  * To add or remove elements from lists (e.g., line items, discounts, gift cards), use their dedicated endpoints.
  * @param cart - Cart to be updated, may be partial.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField cart
  * @permissionId ecom:v2:cart:update_cart
@@ -4057,7 +4057,7 @@ declare function getCurrentCart(): Promise<NonNullablePaths<GetCurrentCartRespon
 declare function updateCurrentCart(cart: Cart): Promise<NonNullablePaths<UpdateCurrentCartResponse, `cart._id` | `cart.revision` | `cart.lineItems` | `cart.lineItems.${number}._id` | `cart.lineItems.${number}.name.original` | `cart.lineItems.${number}.quantityInfo.confirmedQuantity` | `cart.lineItems.${number}.quantityInfo.requestedQuantity` | `cart.lineItems.${number}.quantityInfo.fixedQuantity` | `cart.lineItems.${number}.pricing.unitPrice.amount` | `cart.lineItems.${number}.pricing.unitPrice.convertedAmount` | `cart.lineItems.${number}.pricing.priceDescription.original` | `cart.lineItems.${number}.pricing.priceUndetermined` | `cart.lineItems.${number}.source.catalogReference.catalogItemId` | `cart.lineItems.${number}.source.catalogReference.appId` | `cart.lineItems.${number}.attributes.itemType.preset` | `cart.lineItems.${number}.attributes.itemType.custom` | `cart.lineItems.${number}.attributes.physicalProperties.shippable` | `cart.lineItems.${number}.attributes.membersOnly` | `cart.lineItems.${number}.taxConfig.taxableAddress.addressType` | `cart.lineItems.${number}.paymentConfig.savePaymentMethod` | `cart.lineItems.${number}.paymentConfig.selectedMembership._id` | `cart.lineItems.${number}.paymentConfig.selectedMembership.appId` | `cart.lineItems.${number}.paymentConfig.paymentOption` | `cart.lineItems.${number}.status` | `cart.lineItems.${number}.customLineItem` | `cart.coupons` | `cart.coupons.${number}._id` | `cart.coupons.${number}.code` | `cart.source.channelType` | `cart.source.externalReferences` | `cart.source.externalReferences.${number}.appId` | `cart.source.createdBy.visitorId` | `cart.source.createdBy.memberId` | `cart.source.createdBy.userId` | `cart.source.createdBy.appId` | `cart.source.customContentReference.appId` | `cart.source.customContentReference.componentId` | `cart.businessInfo.languageCode` | `cart.businessInfo.currencyCode` | `cart.customerInfo.visitorId` | `cart.customerInfo.memberId` | `cart.customerInfo.userId` | `cart.customerInfo.vatId._id` | `cart.customerInfo.vatId.type` | `cart.customerInfo.languageCode` | `cart.customerInfo.currencyCode` | `cart.deliveryInfo.address.streetAddress.number` | `cart.deliveryInfo.address.streetAddress.name` | `cart.deliveryInfo.method.code` | `cart.deliveryInfo.method.pickup` | `cart.deliveryInfo.weightUnit` | `cart.taxInfo.pricesIncludeTax` | `cart.paymentInfo.giftCards` | `cart.paymentInfo.giftCards.${number}._id` | `cart.paymentInfo.giftCards.${number}.obfuscatedCode` | `cart.paymentInfo.giftCards.${number}.appId` | `cart.paymentInfo.currencyCode` | `cart.orderPlaced` | `cart.currentCart`, 7>>;
 /**
  * Deletes the Current Cart of the customer.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @permissionId ecom:v2:cart:delete_cart
  * @applicableIdentity APP
@@ -4066,7 +4066,7 @@ declare function updateCurrentCart(cart: Cart): Promise<NonNullablePaths<UpdateC
 declare function deleteCurrentCart(): Promise<void>;
 /**
  * Re-evaluates prices, inventory and discounts to ensure the Cart is up-to-date with the latest changes.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @permissionId ecom:v2:cart:refresh_cart
  * @applicableIdentity APP
@@ -4076,7 +4076,7 @@ declare function refreshCurrentCart(): Promise<NonNullablePaths<RefreshCurrentCa
 /**
  * Calculates the cart based on its current state (line items, discounts, delivery method, etc.)
  * and returns a detailed summary including subtotal, delivery costs, taxes, fees and the total price.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @permissionId ecom:v2:cart:calculate_cart
  * @applicableIdentity APP
@@ -4104,7 +4104,7 @@ interface CalculateCurrentCartOptions {
 /**
  * Adds line items to the Cart.
  * If a Current Cart is not already existing, it will be created.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField options.catalogItems.catalogReference
  * @requiredField options.catalogItems.quantity
@@ -4135,7 +4135,7 @@ interface AddLineItemsToCurrentCartOptions {
 /**
  * Removes line items from the Cart.
  * @param lineItemIds - Line item IDs to remove from cart.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField lineItemIds
  * @permissionId ecom:v2:cart:update_cart
@@ -4146,7 +4146,7 @@ declare function removeLineItemsFromCurrentCart(lineItemIds: string[]): Promise<
 /**
  * Updates line items in the Cart.
  * Use this endpoint to update line items properties such as quantity and selected membership.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField options.lineItems.lineItemId
  * @requiredField options.lineItems.quantity.newQuantity
@@ -4168,7 +4168,7 @@ interface UpdateLineItemsInCurrentCartOptions {
  * @param coupon - Coupon to apply.
  *
  * Currently only one is supported.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField coupon
  * @requiredField coupon.code
@@ -4180,7 +4180,7 @@ declare function addCouponToCurrentCart(coupon: NonNullablePaths<CouponInput, `c
 /**
  * Removes a coupon from the Cart.
  * @param couponId - Coupon ID.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField couponId
  * @permissionId ecom:v2:cart:update_cart
@@ -4191,7 +4191,7 @@ declare function removeCouponFromCurrentCart(couponId: string): Promise<NonNulla
 /**
  * Sets the delivery method for the Current Cart.
  * @param deliveryMethod - Delivery method.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField deliveryMethod
  * @requiredField deliveryMethod.code
@@ -4206,7 +4206,7 @@ declare function setDeliveryMethodForCurrentCart(deliveryMethod: NonNullablePath
  * @param giftCard - Gift card code.
  *
  * Currently only one is supported.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField giftCard
  * @requiredField giftCard.code
@@ -4218,7 +4218,7 @@ declare function addGiftCardToCurrentCart(giftCard: NonNullablePaths<GiftCardInp
 /**
  * Removes a gift card from the Current Cart.
  * @param giftCardId - Gift card ID.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField giftCardId
  * @permissionId ecom:v2:cart:update_cart