@wix/auto_sdk_ecom_cart-v-2 1.0.22 → 1.0.23

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

@@ -30,7 +30,10 @@ interface Cart {
      * @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 +45,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. */
@@ -2187,8 +2191,10 @@ 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?: ConvertedMoney;
+    depositAmount?: string | null;
     /**
      * Type of selected payment option for current item.
      *
@@ -2225,6 +2231,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).
@@ -2612,6 +2624,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).
@@ -2989,7 +3007,10 @@ interface UpdateCart {
      * @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 +3022,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. */
@@ -3092,6 +3114,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).

package/build/internal/cjs/index.typings.js

@@ -171,18 +171,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"
           },
@@ -227,10 +219,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"
             },
@@ -280,10 +268,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"
             },
@@ -323,10 +307,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"
           },
@@ -367,10 +347,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"
             },
@@ -441,10 +417,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"
             },
@@ -494,10 +466,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"
             },
@@ -585,10 +553,6 @@ function addLineItems(payload) {
       {
         transformFn: import_timestamp.transformSDKTimestampToRESTTimestamp,
         paths: [
-          {
-            path: "catalogItems.catalogOverrideFields.image.urlExpirationDate"
-          },
-          { path: "customItems.attributes.image.urlExpirationDate" },
           {
             path: "customItems.attributes.subscriptionInfo.subscriptionSettings.startDate"
           },
@@ -616,10 +580,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"
             },
@@ -669,10 +629,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"
             },
@@ -722,10 +678,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"
             },
@@ -775,10 +727,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"
             },
@@ -828,10 +776,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"
             },
@@ -881,10 +825,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"
             },
@@ -934,10 +874,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"
             },
@@ -987,10 +923,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"
             },
@@ -1474,6 +1406,7 @@ async function calculateCart2(cartId, options) {
   const { httpClient, sideEffects } = arguments[2];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     cartId,
+    refreshCart: options?.refreshCart,
     validationsConfig: options?.validationsConfig,
     customCalculationConfig: options?.customCalculationConfig
   });
@@ -1511,6 +1444,7 @@ async function calculateCart2(cartId, options) {
         spreadPathsToArguments: {},
         explicitPathsToArguments: {
           cartId: "$[0]",
+          refreshCart: "$[1].refreshCart",
           validationsConfig: "$[1].validationsConfig",
           customCalculationConfig: "$[1].customCalculationConfig"
         },