@wix/auto_sdk_ecom_cart-v-2 1.0.40 → 1.0.42

package/build/internal/cjs/index.typings.d.ts

@@ -3989,7 +3989,7 @@ type GetCartApplicationErrors = {
 };
 /**
  * Creates a Cart.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField options.catalogItems.catalogReference
  * @requiredField options.catalogItems.quantity
@@ -4042,7 +4042,7 @@ interface CreateCartOptions {
 /**
  * Retrieves a Cart.
  * @param cartId - ID of the Cart to retrieve.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField cartId
  * @permissionId ecom:v2:cart:get_cart
@@ -4059,7 +4059,7 @@ declare function getCart(cartId: string): Promise<NonNullablePaths<Cart, `_id` |
  * 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 _id - Cart ID.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField _id
  * @requiredField cart
@@ -4181,7 +4181,7 @@ interface UpdateCart {
 /**
  * Deletes a Cart.
  * @param cartId - ID of the Cart to delete.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField cartId
  * @permissionId ecom:v2:cart:delete_cart
@@ -4192,7 +4192,7 @@ declare function deleteCart(cartId: string): Promise<void>;
 /**
  * Re-evaluates prices, inventory and discounts to ensure the Cart is up-to-date with the latest changes.
  * @param cartId - ID of the Cart to refresh.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField cartId
  * @permissionId ecom:v2:cart:refresh_cart
@@ -4205,7 +4205,7 @@ declare function refreshCart(cartId: string): Promise<NonNullablePaths<RefreshCa
  * and returns a detailed summary including subtotal, delivery costs, taxes, fees and the total price.
  * Note that discounts are already pre-computed and applied to the Cart.
  * @param cartId - ID of the Cart to calculate.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField cartId
  * @permissionId ecom:v2:cart:calculate_cart
@@ -4237,7 +4237,7 @@ interface CalculateCartOptions {
  * By default, this is the standard Wix checkout page.
  * If `custom_checkout_url` is defined, it overrides the default and is returned as the checkout URL.
  * @param cartId - ID of the Cart to calculate.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField cartId
  * @permissionId ecom:v2:cart:get_checkout_url
@@ -4258,7 +4258,7 @@ interface GetCheckoutUrlOptions {
  *
  * Read more about the [eCommerce Orders API](https://dev.wix.com/api/rest/wix-ecommerce/orders-api/introduction).
  * @param cartId - Cart ID.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField cartId
  * @permissionId ecom:v2:cart:place_order
@@ -4288,7 +4288,7 @@ interface PlaceOrderOptions {
 /**
  * Adds line items to the Cart.
  * @param cartId - Cart ID.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField cartId
  * @requiredField options.catalogItems.catalogReference
@@ -4322,7 +4322,7 @@ interface AddLineItemsOptions {
  * Removes line items from the Cart.
  * @param cartId - Cart ID.
  * @param lineItemIds - Line item IDs to remove from cart.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField cartId
  * @requiredField lineItemIds
@@ -4335,7 +4335,7 @@ declare function removeLineItems(cartId: string, lineItemIds: string[]): Promise
  * Updates line items in the Cart.
  * Use this endpoint to update line items properties such as quantity and selected membership.
  * @param cartId - Cart ID.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField cartId
  * @requiredField options.lineItems.lineItemId
@@ -4359,7 +4359,7 @@ interface UpdateLineItemsOptions {
  * @param coupon - Coupon to apply.
  *
  * Currently only one is supported.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField cartId
  * @requiredField coupon
@@ -4373,7 +4373,7 @@ declare function addCoupon(cartId: string, coupon: NonNullablePaths<CouponInput,
  * Removes a coupon from the Cart.
  * @param cartId - Cart ID.
  * @param couponId - Discount ID.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField cartId
  * @requiredField couponId
@@ -4386,7 +4386,7 @@ declare function removeCoupon(cartId: string, couponId: string): Promise<NonNull
  * Sets the delivery method for the Cart.
  * @param cartId - Cart ID.
  * @param deliveryMethod - Delivery method.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField cartId
  * @requiredField deliveryMethod
@@ -4403,7 +4403,7 @@ declare function setDeliveryMethod(cartId: string, deliveryMethod: NonNullablePa
  * @param giftCard - Gift card code.
  *
  * Currently only one is supported.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField cartId
  * @requiredField giftCard
@@ -4417,7 +4417,7 @@ declare function addGiftCard(cartId: string, giftCard: NonNullablePaths<GiftCard
  * Removes a gift card from the Cart.
  * @param cartId - Cart ID.
  * @param giftCardId - Gift card ID.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField cartId
  * @requiredField giftCardId
@@ -4431,7 +4431,7 @@ declare function removeGiftCard(cartId: string, giftCardId: string): Promise<Non
  *
  * Sets the `orderPlaced` field to `true`.
  * @param cartId - Cart ID.
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField cartId
  * @permissionId ecom:v2:cart:update_cart
@@ -4452,7 +4452,7 @@ interface MarkCartAsCompletedOptions {
  * Triggered by Wix Cashier after payment completion, this endpoint finalizes the checkout process and redirects the user to the previously provided success URL.
  * In some cases, this endpoint might be called directly by the external payment provider.
  * @param token - Server-signed JWT token with required information to complete checkout
- * @internal
+ * @public
  * @documentationMaturity preview
  * @requiredField token
  * @permissionId ecom:v2:cart:update_cart