@wix/auto_sdk_ecom_current-cart-v-2 1.0.23 → 1.0.25

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

@@ -24,8 +24,7 @@ interface Cart {
     revision?: string | null;
     /**
      * Line items added to the Cart by the customer.
-     * This list may include both valid items (in stock) and invalid ones (e.g., out of stock).
-     * When submitting an order, only valid items will be included in the order.
+     * This list may include items in stock and invalid out out stock.
      * @maxSize 300
      * @readonly
      */
@@ -230,6 +229,7 @@ interface ConvertedMoney {
      * Default: `amount`.
      * @format DECIMAL_VALUE
      * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
+     * @readonly
      */
     convertedAmount?: string;
 }
@@ -1065,7 +1065,9 @@ interface BusinessInfo {
      */
     languageCode?: string;
     /**
-     * The business’s default currency, represented as a three-letter ISO 4217 code.
+     * The business’s default currency, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     *
+     * This represents the base currency configured for the site and remains constant regardless of the [customer’s currency selection](https://support.wix.com/en/article/multicurrency-an-overview).
      * @format CURRENCY
      * @readonly
      */
@@ -1134,8 +1136,9 @@ interface CustomerInfo extends CustomerInfoIdOneOf {
      */
     languageCode?: string;
     /**
-     * Customer’s currency, represented as a three-letter ISO 4217 code.
-     * Resolved automatically from the request metadata ('x-wix-currency' header).
+     * The currency [selected by the customer](https://support.wix.com/en/article/multicurrency-an-overview)  during the purchase flow, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     *
+     * This reflects the customer’s preferred display currency and may differ from the site’s default currency.
      * @format CURRENCY
      * @readonly
      */
@@ -1305,7 +1308,9 @@ interface PaymentInfo {
      */
     giftCards?: GiftCard[];
     /**
-     * The currency to pay with, represented as a three-letter ISO 4217 code.
+     * The currency used for processing the payment, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     *
+     * This is determined by the customer’s selected currency and the site’s supported payment currencies. If the customer’s selected currency is supported for payment, this matches the `customerInfo.currencyCode` property. If not supported, this falls back to the `businessInfo.currencyCode` property.
      * @format CURRENCY
      * @readonly
      */
@@ -2018,7 +2023,6 @@ interface CreateCurrentCartRequest {
     /**
      * Coupons to apply.
      * Currently only one is supported.
-     * If the coupon code is invalid, the cart will be created without it.
      * @maxSize 1
      * @minLength 1
      * @maxLength 50
@@ -2027,7 +2031,6 @@ interface CreateCurrentCartRequest {
     /**
      * Gift cards to add.
      * Currently only one is support.
-     * If the gift card code is invalid, the cart will be created without it.
      * @maxSize 1
      * @minLength 8
      * @maxLength 20
@@ -2102,18 +2105,14 @@ interface CustomItemPricingInfo {
     /**
      * Sale price of a single item, without modifiers.
      * Includes tax if `tax_info.prices_include_tax` is true.
-     * @format DECIMAL_VALUE
-     * @decimalValue options { gte:0, lte:1000000000000000, maxScale:3 }
      */
-    price?: string;
+    price?: ConvertedMoney;
     /**
      * Full price of a single item before any discounts, without modifiers.
      * Defaults to `price` when not provided.
      * Includes tax if `tax_info.prices_include_tax` is true.
-     * @format DECIMAL_VALUE
-     * @decimalValue options { gte:0, lte:1000000000000000, maxScale:3 }
      */
-    fullPrice?: string | null;
+    fullPrice?: ConvertedMoney;
     /**
      * Additional description for the price.
      * For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
@@ -2191,10 +2190,8 @@ interface CustomItemPaymentConfig {
     /**
      * Partial payment to be paid upfront during the checkout.
      * Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
-     * @format DECIMAL_VALUE
-     * @decimalValue options { gte:0, lte:1000000000000000, maxScale:3 }
      */
-    depositAmount?: string | null;
+    depositAmount?: ConvertedMoney;
     /**
      * Type of selected payment option for current item.
      *
@@ -2559,7 +2556,6 @@ interface CreateCartRequest {
     /**
      * Coupons to apply.
      * Currently only one is supported.
-     * If the coupon code is invalid, the cart will be created without it.
      * @maxSize 1
      * @minLength 1
      * @maxLength 50
@@ -2568,7 +2564,6 @@ interface CreateCartRequest {
     /**
      * Gift cards to add.
      * Currently only one is support.
-     * If the gift card code is invalid, the cart will be created without it.
      * @maxSize 1
      * @minLength 8
      * @maxLength 20
@@ -2733,7 +2728,7 @@ interface PlaceOrderResponse {
      */
     paymentGatewayOrderId?: string | null;
     /** Whether an order was successfully created from this cart and the payment transaction was completed. */
-    cartCompleted?: boolean;
+    completed?: boolean;
 }
 interface AddLineItemsRequest {
     /**
@@ -2932,7 +2927,6 @@ interface CreateCurrentCartOptions {
     /**
      * Coupons to apply.
      * Currently only one is supported.
-     * If the coupon code is invalid, the cart will be created without it.
      * @maxSize 1
      * @minLength 1
      * @maxLength 50
@@ -2941,7 +2935,6 @@ interface CreateCurrentCartOptions {
     /**
      * Gift cards to add.
      * Currently only one is support.
-     * If the gift card code is invalid, the cart will be created without it.
      * @maxSize 1
      * @minLength 8
      * @maxLength 20
@@ -2990,9 +2983,6 @@ 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.
- * Note that discounts are already pre-computed and applied to the Cart.
- *
- * This is a read-only operation that does not modify the cart.
  * @internal
  * @documentationMaturity preview
  * @permissionId ecom:v2:cart:calculate_cart