@wix/auto_sdk_ecom_cart-v-2 1.0.22 → 1.0.24

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

@@ -24,13 +24,15 @@ 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
      */
     lineItems?: V2LineItem[];
-    /** The sum of all line item final prices. */
+    /**
+     * The sum of all line item final prices.
+     * @readonly
+     */
     subtotal?: ConvertedMoney;
     /**
      * Optional message left by the customer.
@@ -42,6 +44,7 @@ interface Cart {
      * List of coupons added to the Cart.
      * Currently, only one coupon code is supported.
      * @maxSize 1
+     * @readonly
      */
     coupons?: Coupon[];
     /** Information about the source of the Cart, detailing the origin or context in which the Cart was created. */
@@ -226,6 +229,7 @@ interface ConvertedMoney {
      * Default: `amount`.
      * @format DECIMAL_VALUE
      * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
+     * @readonly
      */
     convertedAmount?: string;
 }
@@ -2014,7 +2018,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
@@ -2023,7 +2026,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
@@ -2098,18 +2100,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".
@@ -2225,6 +2223,12 @@ interface RefreshCurrentCartResponse {
     cart?: Cart;
 }
 interface CalculateCurrentCartRequest {
+    /**
+     * Whether to retrieve the latest item prices, discounts, and inventory data from the catalogs before calculating the cart.
+     *
+     * Default: `false`
+     */
+    refreshCart?: boolean;
     /**
      * Specifies the level of **business validation** to perform during cart calculation,
      * by calling the [Validations service plugin](https://dev.wix.com/api/rest/wix-ecommerce/validations-integration-spi/introduction).
@@ -2547,7 +2551,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
@@ -2556,7 +2559,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
@@ -2612,6 +2614,12 @@ interface CalculateCartRequest {
      * @format GUID
      */
     cartId: string;
+    /**
+     * Whether to retrieve the latest item prices, discounts, and inventory data from the catalogs before calculating the cart.
+     *
+     * Default: `false`
+     */
+    refreshCart?: boolean;
     /**
      * Specifies the level of **business validation** to perform during cart calculation,
      * by calling the [Validations service plugin](https://dev.wix.com/api/rest/wix-ecommerce/validations-integration-spi/introduction).
@@ -2715,7 +2723,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 {
     /**
@@ -2915,7 +2923,6 @@ interface CreateCartOptions {
     /**
      * 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
@@ -2924,7 +2931,6 @@ interface CreateCartOptions {
     /**
      * 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
@@ -2983,13 +2989,15 @@ interface UpdateCart {
     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
      */
     lineItems?: V2LineItem[];
-    /** The sum of all line item final prices. */
+    /**
+     * The sum of all line item final prices.
+     * @readonly
+     */
     subtotal?: ConvertedMoney;
     /**
      * Optional message left by the customer.
@@ -3001,6 +3009,7 @@ interface UpdateCart {
      * List of coupons added to the Cart.
      * Currently, only one coupon code is supported.
      * @maxSize 1
+     * @readonly
      */
     coupons?: Coupon[];
     /** Information about the source of the Cart, detailing the origin or context in which the Cart was created. */
@@ -3081,8 +3090,6 @@ declare function refreshCart(cartId: string): Promise<NonNullablePaths<RefreshCa
  * 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.
  * @param cartId - ID of the Cart to calculate.
  * @internal
  * @documentationMaturity preview
@@ -3092,6 +3099,12 @@ declare function refreshCart(cartId: string): Promise<NonNullablePaths<RefreshCa
  */
 declare function calculateCart(cartId: string, options?: CalculateCartOptions): Promise<NonNullablePaths<CalculateCartResponse, `cart._id` | `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.settings.lockGiftCard` | `cart.settings.lockCouponCode` | `cart.settings.policyAgreementCheckboxDisabled` | `cart.settings.manualPaymentDisabled` | `summary.cartId` | `summary.lineItems` | `summary.lineItems.${number}.lineItemId` | `summary.lineItems.${number}.quantity` | `summary.lineItems.${number}.unitPrice.amount` | `summary.lineItems.${number}.unitPrice.convertedAmount` | `summary.discounts` | `summary.discounts.${number}.name.original` | `summary.discounts.${number}.source.sourceType` | `summary.discounts.${number}.scope` | `summary.deliverySummary.method.code` | `summary.deliverySummary.method.pickup` | `summary.additionalFees` | `summary.taxSummary.taxes` | `summary.taxSummary.pricesIncludeTax` | `summary.taxSummary.lineItemTaxes` | `summary.taxSummary.lineItemTaxes.${number}.lineItemId` | `summary.taxSummary.additionalFeeTaxes` | `summary.taxSummary.additionalFeeTaxes.${number}.additionalFeeCode` | `summary.paymentSummary.giftCards` | `summary.paymentSummary.giftCards.${number}.giftCardId` | `summary.paymentSummary.memberships` | `summary.paymentSummary.memberships.${number}._id` | `summary.paymentSummary.memberships.${number}.appId` | `summary.paymentSummary.subscriptionCharges` | `summary.paymentSummary.requiresPaymentAfterGiftCard` | `summary.calculationErrors.generalShippingCalculationError.applicationError.code` | `summary.calculationErrors.generalShippingCalculationError.applicationError.description` | `summary.calculationErrors.generalShippingCalculationError.validationError.fieldViolations` | `summary.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.field` | `summary.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.description` | `summary.calculationErrors.generalShippingCalculationError.validationError.fieldViolations.${number}.violatedRule` | `summary.calculationErrors.carrierErrors.errors` | `summary.calculationErrors.carrierErrors.errors.${number}.carrierId` | `summary.calculationErrors.orderValidationErrors` | `summary.spiViolations` | `summary.spiViolations.${number}.severity` | `summary.spiViolations.${number}.target.other.name` | `summary.spiViolations.${number}.target.lineItem.name`, 8>>;
 interface CalculateCartOptions {
+    /**
+     * Whether to retrieve the latest item prices, discounts, and inventory data from the catalogs before calculating the cart.
+     *
+     * Default: `false`
+     */
+    refreshCart?: boolean;
     /**
      * Specifies the level of **business validation** to perform during cart calculation,
      * by calling the [Validations service plugin](https://dev.wix.com/api/rest/wix-ecommerce/validations-integration-spi/introduction).
@@ -3135,7 +3148,7 @@ interface GetCheckoutUrlOptions {
  * @permissionId ecom:v2:cart:place_order
  * @fqn wix.ecom.cart.v2.CartService.PlaceOrder
  */
-declare function placeOrder(cartId: string, options?: PlaceOrderOptions): Promise<NonNullablePaths<PlaceOrderResponse, `orderId` | `cartCompleted`, 2>>;
+declare function placeOrder(cartId: string, options?: PlaceOrderOptions): Promise<NonNullablePaths<PlaceOrderResponse, `orderId` | `completed`, 2>>;
 interface PlaceOrderOptions {
     /**
      * The pricing token received from `CalculateCart`'s response.

package/build/internal/es/index.typings.mjs

@@ -113,18 +113,10 @@ function createCart(payload) {
         paths: [
           { path: "cart.createdDate" },
           { path: "cart.updatedDate" },
-          {
-            path: "cart.lineItems.source.catalogOverrideFields.image.urlExpirationDate"
-          },
-          { path: "cart.lineItems.attributes.image.urlExpirationDate" },
           {
             path: "cart.lineItems.attributes.subscriptionInfo.subscriptionSettings.startDate"
           },
           { path: "cart.lineItems.attributes.serviceProperties.scheduledDate" },
-          {
-            path: "catalogItems.catalogOverrideFields.image.urlExpirationDate"
-          },
-          { path: "customItems.attributes.image.urlExpirationDate" },
           {
             path: "customItems.attributes.subscriptionInfo.subscriptionSettings.startDate"
           },
@@ -169,10 +161,6 @@ function createCart(payload) {
           paths: [
             { path: "cart.createdDate" },
             { path: "cart.updatedDate" },
-            {
-              path: "cart.lineItems.source.catalogOverrideFields.image.urlExpirationDate"
-            },
-            { path: "cart.lineItems.attributes.image.urlExpirationDate" },
             {
               path: "cart.lineItems.attributes.subscriptionInfo.subscriptionSettings.startDate"
             },
@@ -222,10 +210,6 @@ function getCart(payload) {
           paths: [
             { path: "cart.createdDate" },
             { path: "cart.updatedDate" },
-            {
-              path: "cart.lineItems.source.catalogOverrideFields.image.urlExpirationDate"
-            },
-            { path: "cart.lineItems.attributes.image.urlExpirationDate" },
             {
               path: "cart.lineItems.attributes.subscriptionInfo.subscriptionSettings.startDate"
             },
@@ -265,10 +249,6 @@ function updateCart(payload) {
         paths: [
           { path: "cart.createdDate" },
           { path: "cart.updatedDate" },
-          {
-            path: "cart.lineItems.source.catalogOverrideFields.image.urlExpirationDate"
-          },
-          { path: "cart.lineItems.attributes.image.urlExpirationDate" },
           {
             path: "cart.lineItems.attributes.subscriptionInfo.subscriptionSettings.startDate"
           },
@@ -309,10 +289,6 @@ function updateCart(payload) {
           paths: [
             { path: "cart.createdDate" },
             { path: "cart.updatedDate" },
-            {
-              path: "cart.lineItems.source.catalogOverrideFields.image.urlExpirationDate"
-            },
-            { path: "cart.lineItems.attributes.image.urlExpirationDate" },
             {
               path: "cart.lineItems.attributes.subscriptionInfo.subscriptionSettings.startDate"
             },
@@ -383,10 +359,6 @@ function refreshCart(payload) {
           paths: [
             { path: "cart.createdDate" },
             { path: "cart.updatedDate" },
-            {
-              path: "cart.lineItems.source.catalogOverrideFields.image.urlExpirationDate"
-            },
-            { path: "cart.lineItems.attributes.image.urlExpirationDate" },
             {
               path: "cart.lineItems.attributes.subscriptionInfo.subscriptionSettings.startDate"
             },
@@ -436,10 +408,6 @@ function calculateCart(payload) {
           paths: [
             { path: "cart.createdDate" },
             { path: "cart.updatedDate" },
-            {
-              path: "cart.lineItems.source.catalogOverrideFields.image.urlExpirationDate"
-            },
-            { path: "cart.lineItems.attributes.image.urlExpirationDate" },
             {
               path: "cart.lineItems.attributes.subscriptionInfo.subscriptionSettings.startDate"
             },
@@ -527,10 +495,6 @@ function addLineItems(payload) {
       {
         transformFn: transformSDKTimestampToRESTTimestamp,
         paths: [
-          {
-            path: "catalogItems.catalogOverrideFields.image.urlExpirationDate"
-          },
-          { path: "customItems.attributes.image.urlExpirationDate" },
           {
             path: "customItems.attributes.subscriptionInfo.subscriptionSettings.startDate"
           },
@@ -558,10 +522,6 @@ function addLineItems(payload) {
           paths: [
             { path: "cart.createdDate" },
             { path: "cart.updatedDate" },
-            {
-              path: "cart.lineItems.source.catalogOverrideFields.image.urlExpirationDate"
-            },
-            { path: "cart.lineItems.attributes.image.urlExpirationDate" },
             {
               path: "cart.lineItems.attributes.subscriptionInfo.subscriptionSettings.startDate"
             },
@@ -611,10 +571,6 @@ function removeLineItems(payload) {
           paths: [
             { path: "cart.createdDate" },
             { path: "cart.updatedDate" },
-            {
-              path: "cart.lineItems.source.catalogOverrideFields.image.urlExpirationDate"
-            },
-            { path: "cart.lineItems.attributes.image.urlExpirationDate" },
             {
               path: "cart.lineItems.attributes.subscriptionInfo.subscriptionSettings.startDate"
             },
@@ -664,10 +620,6 @@ function updateLineItems(payload) {
           paths: [
             { path: "cart.createdDate" },
             { path: "cart.updatedDate" },
-            {
-              path: "cart.lineItems.source.catalogOverrideFields.image.urlExpirationDate"
-            },
-            { path: "cart.lineItems.attributes.image.urlExpirationDate" },
             {
               path: "cart.lineItems.attributes.subscriptionInfo.subscriptionSettings.startDate"
             },
@@ -717,10 +669,6 @@ function addCoupon(payload) {
           paths: [
             { path: "cart.createdDate" },
             { path: "cart.updatedDate" },
-            {
-              path: "cart.lineItems.source.catalogOverrideFields.image.urlExpirationDate"
-            },
-            { path: "cart.lineItems.attributes.image.urlExpirationDate" },
             {
               path: "cart.lineItems.attributes.subscriptionInfo.subscriptionSettings.startDate"
             },
@@ -770,10 +718,6 @@ function removeCoupon(payload) {
           paths: [
             { path: "cart.createdDate" },
             { path: "cart.updatedDate" },
-            {
-              path: "cart.lineItems.source.catalogOverrideFields.image.urlExpirationDate"
-            },
-            { path: "cart.lineItems.attributes.image.urlExpirationDate" },
             {
               path: "cart.lineItems.attributes.subscriptionInfo.subscriptionSettings.startDate"
             },
@@ -823,10 +767,6 @@ function addGiftCard(payload) {
           paths: [
             { path: "cart.createdDate" },
             { path: "cart.updatedDate" },
-            {
-              path: "cart.lineItems.source.catalogOverrideFields.image.urlExpirationDate"
-            },
-            { path: "cart.lineItems.attributes.image.urlExpirationDate" },
             {
               path: "cart.lineItems.attributes.subscriptionInfo.subscriptionSettings.startDate"
             },
@@ -876,10 +816,6 @@ function removeGiftCard(payload) {
           paths: [
             { path: "cart.createdDate" },
             { path: "cart.updatedDate" },
-            {
-              path: "cart.lineItems.source.catalogOverrideFields.image.urlExpirationDate"
-            },
-            { path: "cart.lineItems.attributes.image.urlExpirationDate" },
             {
               path: "cart.lineItems.attributes.subscriptionInfo.subscriptionSettings.startDate"
             },
@@ -929,10 +865,6 @@ function markCartAsCompleted(payload) {
           paths: [
             { path: "cart.createdDate" },
             { path: "cart.updatedDate" },
-            {
-              path: "cart.lineItems.source.catalogOverrideFields.image.urlExpirationDate"
-            },
-            { path: "cart.lineItems.attributes.image.urlExpirationDate" },
             {
               path: "cart.lineItems.attributes.subscriptionInfo.subscriptionSettings.startDate"
             },
@@ -1416,6 +1348,7 @@ async function calculateCart2(cartId, options) {
   const { httpClient, sideEffects } = arguments[2];
   const payload = renameKeysFromSDKRequestToRESTRequest({
     cartId,
+    refreshCart: options?.refreshCart,
     validationsConfig: options?.validationsConfig,
     customCalculationConfig: options?.customCalculationConfig
   });
@@ -1453,6 +1386,7 @@ async function calculateCart2(cartId, options) {
         spreadPathsToArguments: {},
         explicitPathsToArguments: {
           cartId: "$[0]",
+          refreshCart: "$[1].refreshCart",
           validationsConfig: "$[1].validationsConfig",
           customCalculationConfig: "$[1].customCalculationConfig"
         },