@wix/auto_sdk_ecom_cart-v-2 1.0.16 → 1.0.17

package/build/cjs/index.d.ts

@@ -123,7 +123,7 @@ interface V2LineItem {
     /**
      * Custom extended fields for the line item object.
      *
-     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
+     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured using the 'Checkout & Orders - Line Items Schema Plugin' in the app dashboard before they can be accessed with API calls.
      */
     extendedFields?: ExtendedFields;
     /**
@@ -1489,16 +1489,6 @@ interface CartSummary {
     priceSummary?: PriceSummary;
     /** Payment details summarizing how the customer will pay for the order. */
     paymentSummary?: PaymentSummary;
-    /**
-     * List of errors that occurred during the calculation process.
-     * @maxSize 100
-     */
-    errors?: CalculationError[];
-    /**
-     * List of business violations raised by the Validations service plugin ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/service-plugins/validations/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/validations-integration-service-plugin/introduction)).
-     * @maxSize 100
-     */
-    violations?: Violation[];
     /**
      * A token representing the Cart's calculated prices.
      *
@@ -1515,6 +1505,17 @@ interface CartSummary {
      * @maxLength 1024
      */
     priceVerificationToken?: string | null;
+    /**
+     * List of errors that occurred during the calculation process, returned by Totals Calculator.
+     * TODO: Temporary field for backward compatibility; will be removed once we introduce the unified 'violations' model.
+     */
+    calculationErrors?: CalculationErrors;
+    /**
+     * List of business violations raised by the Validations service plugin ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/service-plugins/validations/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/validations-integration-service-plugin/introduction)).
+     * TODO: Temporary field for backward compatibility; will be removed once we introduce the unified 'violations' model.
+     * @maxSize 100
+     */
+    spiViolations?: Violation[];
 }
 interface LineItemSummary {
     /**
@@ -1759,32 +1760,37 @@ interface Charge {
     /** The billing date from which the charge starts. */
     cycleBillingDate?: Date | null;
 }
-interface CalculationError {
-    /** The calculation component that caused the error. */
-    component?: CalculationComponentWithLiterals;
-    /** Machine-readable error code. */
-    code?: ErrorCodeWithLiterals;
+interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
+    /** General shipping calculation error. */
+    generalShippingCalculationError?: Details;
+    /** Carrier errors. */
+    carrierErrors?: CarrierErrors;
+    /** Tax calculation error. */
+    taxCalculationError?: Details;
+    /** Coupon calculation error. */
+    couponCalculationError?: Details;
+    /** Gift card calculation error. */
+    giftCardCalculationError?: Details;
+    /**
+     * Order validation errors.
+     * @maxSize 100
+     */
+    orderValidationErrors?: ApplicationError[];
     /**
-     * Human-readable explanation.
-     * @maxLength 100
+     * Membership payment methods calculation errors
+     * For example, will indicate that a line item that must be paid with membership payment doesn't have one or selected memberships are invalid
      */
-    description?: string | null;
-}
-declare enum CalculationComponent {
-    UNKNOWN_CALCULATION_COMPONENT = "UNKNOWN_CALCULATION_COMPONENT",
-    DISCOUNTS = "DISCOUNTS",
-    DELIVERY = "DELIVERY",
-    TAX = "TAX",
-    MEMBERSHIPS = "MEMBERSHIPS",
-    GIFT_CARDS = "GIFT_CARDS"
+    membershipError?: Details;
+    /** Discount Rule calculation error. */
+    discountsCalculationError?: Details;
 }
-/** @enumType */
-type CalculationComponentWithLiterals = CalculationComponent | 'UNKNOWN_CALCULATION_COMPONENT' | 'DISCOUNTS' | 'DELIVERY' | 'TAX' | 'MEMBERSHIPS' | 'GIFT_CARDS';
-declare enum ErrorCode {
-    UNKNOWN_ERROR_CODE = "UNKNOWN_ERROR_CODE"
+/** @oneof */
+interface CalculationErrorsShippingCalculationErrorOneOf {
+    /** General shipping calculation error. */
+    generalShippingCalculationError?: Details;
+    /** Carrier errors. */
+    carrierErrors?: CarrierErrors;
 }
-/** @enumType */
-type ErrorCodeWithLiterals = ErrorCode | 'UNKNOWN_ERROR_CODE';
 interface Details extends DetailsKindOneOf {
     applicationError?: ApplicationError;
     validationError?: ValidationError;
@@ -1881,6 +1887,22 @@ interface SystemError {
     /** Error code. */
     errorCode?: string | null;
 }
+interface CarrierErrors {
+    /**
+     * Carrier errors.
+     * @maxSize 100
+     */
+    errors?: CarrierError[];
+}
+interface CarrierError {
+    /**
+     * Carrier ID.
+     * @format GUID
+     */
+    carrierId?: string;
+    /** Error details. */
+    error?: Details;
+}
 interface Violation {
     /** Severity of the violation. The violations are shown on the cart and checkout pages. A warning is displayed as yellow, and allows a site visitor to proceed with caution. An error is displayed as red, and doesn't allow a site visitor to proceed with the eCommerce flow. */
     severity?: SeverityWithLiterals;
@@ -2614,10 +2636,14 @@ interface PlaceOrderRequest {
     /**
      * The pricing token received from `CalculateCart`'s response.
      * Used to verify that the prices shown to the customer have not changed before completing checkout.
-     * @maxLength 1024
-     * @readonly
+     * @maxLength 3000
      */
     pricingToken?: string | null;
+    /**
+     * Payment token.
+     * @maxLength 100
+     */
+    paymentToken?: string | null;
     /** Urls to redirect to after payment is made. */
     redirectUrls?: RedirectUrls;
     /** Indicates the payment method should be saved on the order */
@@ -2986,10 +3012,14 @@ interface PlaceOrderOptions {
     /**
      * The pricing token received from `CalculateCart`'s response.
      * Used to verify that the prices shown to the customer have not changed before completing checkout.
-     * @maxLength 1024
-     * @readonly
+     * @maxLength 3000
      */
     pricingToken?: string | null;
+    /**
+     * Payment token.
+     * @maxLength 100
+     */
+    paymentToken?: string | null;
     /** Urls to redirect to after payment is made. */
     redirectUrls?: RedirectUrls;
     /** Indicates the payment method should be saved on the order */
@@ -3025,4 +3055,4 @@ interface MarkCartAsCompletedOptions {
     orderId?: string | null;
 }
 
-export { type ActionEvent, type AddCouponRequest, type AddCouponResponse, type AddCouponToCurrentCartRequest, type AddCouponToCurrentCartResponse, type AddGiftCardRequest, type AddGiftCardResponse, type AddGiftCardToCurrentCartRequest, type AddGiftCardToCurrentCartResponse, type AddLineItemsOptions, type AddLineItemsRequest, type AddLineItemsResponse, type AddLineItemsToCurrentCartRequest, type AddLineItemsToCurrentCartResponse, type AdditionalFee, type AdditionalFeeTax, type Address, type AddressLocation, type ApplicationError, type BusinessInfo, type CalculateCartOptions, type CalculateCartRequest, type CalculateCartResponse, type CalculateCurrentCartRequest, type CalculateCurrentCartResponse, CalculationComponent, type CalculationComponentWithLiterals, type CalculationConfig, type CalculationError, type Cart, type CartSettings, type CartSource, type CartSummary, type CatalogItemInput, type CatalogOverrideFields, type CatalogReference, ChannelType, type ChannelTypeWithLiterals, type Charge, type Color, type Coupon, type CreateCartOptions, type CreateCartRequest, type CreateCartResponse, type CreateCurrentCartRequest, type CreateCurrentCartResponse, type CreatedBy, type CreatedByIdOneOf, type CustomContentReference, type CustomField, type CustomItemAttributes, type CustomItemDeliveryConfig, type CustomItemInput, type CustomItemPaymentConfig, type CustomItemPricingInfo, type CustomItemQuantityInfo, type CustomItemSource, type CustomItemTaxConfig, type CustomerInfo, type CustomerInfoIdOneOf, type DeleteCartRequest, type DeleteCartResponse, type DeleteCurrentCartRequest, type DeleteCurrentCartResponse, type DeliveryInfo, type DeliveryMethod, type DeliverySummary, type Description, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type Details, type DetailsKindOneOf, type Discount, type DiscountBenefit, type DiscountBenefitValueOneOf, DiscountScope, type DiscountScopeWithLiterals, type DiscountSource, DiscountSourceType, type DiscountSourceTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, ErrorCode, type ErrorCodeWithLiterals, type ExtendedFields, type ExternalReference, type FieldViolation, FileType, type FileTypeWithLiterals, type FreeTrialPeriod, type FullAddressContactDetails, type GetCartRequest, type GetCartResponse, type GetCheckoutURLRequest, type GetCheckoutURLResponse, type GetCheckoutUrlOptions, type GetCurrentCartRequest, type GetCurrentCartResponse, type GiftCard, type GiftCardSummary, type Group, type HandleAsyncCheckoutCompletionRequest, type HeadersEntry, type IdentificationData, type IdentificationDataIdOneOf, type ItemAttributes, type ItemDeliveryConfig, type ItemDiscount, type ItemModifier, type ItemPaymentConfig, type ItemPriceBreakdown, type ItemPricingInfo, type ItemQuantityInfo, type ItemSource, ItemStatus, type ItemStatusWithLiterals, type ItemTaxConfig, type ItemType, ItemTypeItemType, type ItemTypeItemTypeDataOneOf, type ItemTypeItemTypeWithLiterals, type LegacyFields, type LineItem, type LineItemSummary, type LineItemTax, type LineItemUpdate, type MarkCartAsCompletedOptions, type MarkCartAsCompletedRequest, type MarkCartAsCompletedResponse, type Membership, type MessageEnvelope, type ModifierGroup, type MultiCurrencyPrice, NameInLineItem, type NameInLineItemWithLiterals, NameInOther, type NameInOtherWithLiterals, type Other, type PaymentInfo, type PaymentOption, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PaymentSummary, type PhysicalProperties, type PlaceOrderOptions, type PlaceOrderRequest, type PlaceOrderResponse, type PlainTextValue, type Policy, type PriceDescription, type PriceSummary, type QuantityUpdate, type RawHttpResponse, type RedirectUrls, type RefreshCartRequest, type RefreshCartResponse, type RefreshCurrentCartRequest, type RefreshCurrentCartResponse, type RemoveCouponFromCurrentCartRequest, type RemoveCouponFromCurrentCartResponse, type RemoveCouponRequest, type RemoveCouponResponse, type RemoveGiftCardFromCurrentCartRequest, type RemoveGiftCardFromCurrentCartResponse, type RemoveGiftCardRequest, type RemoveGiftCardResponse, type RemoveLineItemsFromCurrentCartRequest, type RemoveLineItemsFromCurrentCartResponse, type RemoveLineItemsRequest, type RemoveLineItemsResponse, type RestoreInfo, RuleType, type RuleTypeWithLiterals, type Scope, type SecuredMedia, type SelectedMembership, type SelectedMembershipUpdate, type ServiceProperties, Severity, type SeverityWithLiterals, type StreetAddress, type SubscriptionCharges, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionOptionInfo, type SubscriptionSettings, SuggestedFix, type SuggestedFixWithLiterals, type SystemError, type Target, type TargetTargetTypeOneOf, type Tax, type TaxDetails, type TaxInfo, type TaxSummary, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type Title, type TranslatableString, type UpdateCart, type UpdateCartRequest, type UpdateCartResponse, type UpdateCurrentCartRequest, type UpdateCurrentCartResponse, type UpdateLineItemsInCurrentCartRequest, type UpdateLineItemsInCurrentCartResponse, type UpdateLineItemsOptions, type UpdateLineItemsRequest, type UpdateLineItemsResponse, type V2AdditionalFee, type V2LineItem, type ValidationError, ValidationsConfig, type ValidationsConfigWithLiterals, type VatId, VatType, type VatTypeWithLiterals, type Violation, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals };
+export { type ActionEvent, type AddCouponRequest, type AddCouponResponse, type AddCouponToCurrentCartRequest, type AddCouponToCurrentCartResponse, type AddGiftCardRequest, type AddGiftCardResponse, type AddGiftCardToCurrentCartRequest, type AddGiftCardToCurrentCartResponse, type AddLineItemsOptions, type AddLineItemsRequest, type AddLineItemsResponse, type AddLineItemsToCurrentCartRequest, type AddLineItemsToCurrentCartResponse, type AdditionalFee, type AdditionalFeeTax, type Address, type AddressLocation, type ApplicationError, type BusinessInfo, type CalculateCartOptions, type CalculateCartRequest, type CalculateCartResponse, type CalculateCurrentCartRequest, type CalculateCurrentCartResponse, type CalculationConfig, type CalculationErrors, type CalculationErrorsShippingCalculationErrorOneOf, type CarrierError, type CarrierErrors, type Cart, type CartSettings, type CartSource, type CartSummary, type CatalogItemInput, type CatalogOverrideFields, type CatalogReference, ChannelType, type ChannelTypeWithLiterals, type Charge, type Color, type Coupon, type CreateCartOptions, type CreateCartRequest, type CreateCartResponse, type CreateCurrentCartRequest, type CreateCurrentCartResponse, type CreatedBy, type CreatedByIdOneOf, type CustomContentReference, type CustomField, type CustomItemAttributes, type CustomItemDeliveryConfig, type CustomItemInput, type CustomItemPaymentConfig, type CustomItemPricingInfo, type CustomItemQuantityInfo, type CustomItemSource, type CustomItemTaxConfig, type CustomerInfo, type CustomerInfoIdOneOf, type DeleteCartRequest, type DeleteCartResponse, type DeleteCurrentCartRequest, type DeleteCurrentCartResponse, type DeliveryInfo, type DeliveryMethod, type DeliverySummary, type Description, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type Details, type DetailsKindOneOf, type Discount, type DiscountBenefit, type DiscountBenefitValueOneOf, DiscountScope, type DiscountScopeWithLiterals, type DiscountSource, DiscountSourceType, type DiscountSourceTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type ExternalReference, type FieldViolation, FileType, type FileTypeWithLiterals, type FreeTrialPeriod, type FullAddressContactDetails, type GetCartRequest, type GetCartResponse, type GetCheckoutURLRequest, type GetCheckoutURLResponse, type GetCheckoutUrlOptions, type GetCurrentCartRequest, type GetCurrentCartResponse, type GiftCard, type GiftCardSummary, type Group, type HandleAsyncCheckoutCompletionRequest, type HeadersEntry, type IdentificationData, type IdentificationDataIdOneOf, type ItemAttributes, type ItemDeliveryConfig, type ItemDiscount, type ItemModifier, type ItemPaymentConfig, type ItemPriceBreakdown, type ItemPricingInfo, type ItemQuantityInfo, type ItemSource, ItemStatus, type ItemStatusWithLiterals, type ItemTaxConfig, type ItemType, ItemTypeItemType, type ItemTypeItemTypeDataOneOf, type ItemTypeItemTypeWithLiterals, type LegacyFields, type LineItem, type LineItemSummary, type LineItemTax, type LineItemUpdate, type MarkCartAsCompletedOptions, type MarkCartAsCompletedRequest, type MarkCartAsCompletedResponse, type Membership, type MessageEnvelope, type ModifierGroup, type MultiCurrencyPrice, NameInLineItem, type NameInLineItemWithLiterals, NameInOther, type NameInOtherWithLiterals, type Other, type PaymentInfo, type PaymentOption, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PaymentSummary, type PhysicalProperties, type PlaceOrderOptions, type PlaceOrderRequest, type PlaceOrderResponse, type PlainTextValue, type Policy, type PriceDescription, type PriceSummary, type QuantityUpdate, type RawHttpResponse, type RedirectUrls, type RefreshCartRequest, type RefreshCartResponse, type RefreshCurrentCartRequest, type RefreshCurrentCartResponse, type RemoveCouponFromCurrentCartRequest, type RemoveCouponFromCurrentCartResponse, type RemoveCouponRequest, type RemoveCouponResponse, type RemoveGiftCardFromCurrentCartRequest, type RemoveGiftCardFromCurrentCartResponse, type RemoveGiftCardRequest, type RemoveGiftCardResponse, type RemoveLineItemsFromCurrentCartRequest, type RemoveLineItemsFromCurrentCartResponse, type RemoveLineItemsRequest, type RemoveLineItemsResponse, type RestoreInfo, RuleType, type RuleTypeWithLiterals, type Scope, type SecuredMedia, type SelectedMembership, type SelectedMembershipUpdate, type ServiceProperties, Severity, type SeverityWithLiterals, type StreetAddress, type SubscriptionCharges, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionOptionInfo, type SubscriptionSettings, SuggestedFix, type SuggestedFixWithLiterals, type SystemError, type Target, type TargetTargetTypeOneOf, type Tax, type TaxDetails, type TaxInfo, type TaxSummary, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type Title, type TranslatableString, type UpdateCart, type UpdateCartRequest, type UpdateCartResponse, type UpdateCurrentCartRequest, type UpdateCurrentCartResponse, type UpdateLineItemsInCurrentCartRequest, type UpdateLineItemsInCurrentCartResponse, type UpdateLineItemsOptions, type UpdateLineItemsRequest, type UpdateLineItemsResponse, type V2AdditionalFee, type V2LineItem, type ValidationError, ValidationsConfig, type ValidationsConfigWithLiterals, type VatId, VatType, type VatTypeWithLiterals, type Violation, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals };

package/build/cjs/index.js

@@ -20,12 +20,10 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // index.ts
 var index_exports = {};
 __export(index_exports, {
-  CalculationComponent: () => CalculationComponent,
   ChannelType: () => ChannelType,
   DescriptionLineType: () => DescriptionLineType,
   DiscountScope: () => DiscountScope,
   DiscountSourceType: () => DiscountSourceType,
-  ErrorCode: () => ErrorCode,
   FileType: () => FileType,
   ItemStatus: () => ItemStatus,
   ItemTypeItemType: () => ItemTypeItemType,
@@ -1156,19 +1154,6 @@ var DiscountScope = /* @__PURE__ */ ((DiscountScope2) => {
   DiscountScope2["DELIVERY"] = "DELIVERY";
   return DiscountScope2;
 })(DiscountScope || {});
-var CalculationComponent = /* @__PURE__ */ ((CalculationComponent2) => {
-  CalculationComponent2["UNKNOWN_CALCULATION_COMPONENT"] = "UNKNOWN_CALCULATION_COMPONENT";
-  CalculationComponent2["DISCOUNTS"] = "DISCOUNTS";
-  CalculationComponent2["DELIVERY"] = "DELIVERY";
-  CalculationComponent2["TAX"] = "TAX";
-  CalculationComponent2["MEMBERSHIPS"] = "MEMBERSHIPS";
-  CalculationComponent2["GIFT_CARDS"] = "GIFT_CARDS";
-  return CalculationComponent2;
-})(CalculationComponent || {});
-var ErrorCode = /* @__PURE__ */ ((ErrorCode2) => {
-  ErrorCode2["UNKNOWN_ERROR_CODE"] = "UNKNOWN_ERROR_CODE";
-  return ErrorCode2;
-})(ErrorCode || {});
 var RuleType = /* @__PURE__ */ ((RuleType2) => {
   RuleType2["VALIDATION"] = "VALIDATION";
   RuleType2["OTHER"] = "OTHER";
@@ -1571,6 +1556,7 @@ async function placeOrder2(cartId, options) {
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     cartId,
     pricingToken: options?.pricingToken,
+    paymentToken: options?.paymentToken,
     redirectUrls: options?.redirectUrls,
     savePaymentMethod: options?.savePaymentMethod,
     delayCapture: options?.delayCapture
@@ -1589,6 +1575,7 @@ async function placeOrder2(cartId, options) {
         explicitPathsToArguments: {
           cartId: "$[0]",
           pricingToken: "$[1].pricingToken",
+          paymentToken: "$[1].paymentToken",
           redirectUrls: "$[1].redirectUrls",
           savePaymentMethod: "$[1].savePaymentMethod",
           delayCapture: "$[1].delayCapture"
@@ -2178,12 +2165,10 @@ var markCartAsCompleted4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTMo
 var handleAsyncCheckoutCompletion4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(handleAsyncCheckoutCompletion3);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  CalculationComponent,
   ChannelType,
   DescriptionLineType,
   DiscountScope,
   DiscountSourceType,
-  ErrorCode,
   FileType,
   ItemStatus,
   ItemTypeItemType,