@wix/auto_sdk_ecom_cart-v-2 1.0.15 → 1.0.17

package/build/internal/cjs/meta.d.ts

@@ -126,7 +126,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;
     /**
@@ -1461,16 +1461,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.
      *
@@ -1487,6 +1477,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 {
     /**
@@ -1731,32 +1732,149 @@ 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;
+    membershipError?: Details;
+    /** Discount Rule calculation error. */
+    discountsCalculationError?: Details;
 }
-declare enum CalculationComponent {
-    UNKNOWN_CALCULATION_COMPONENT = "UNKNOWN_CALCULATION_COMPONENT",
-    DISCOUNTS = "DISCOUNTS",
-    DELIVERY = "DELIVERY",
-    TAX = "TAX",
-    MEMBERSHIPS = "MEMBERSHIPS",
-    GIFT_CARDS = "GIFT_CARDS"
+/** @oneof */
+interface CalculationErrorsShippingCalculationErrorOneOf {
+    /** General shipping calculation error. */
+    generalShippingCalculationError?: Details;
+    /** Carrier errors. */
+    carrierErrors?: CarrierErrors;
 }
-/** @enumType */
-type CalculationComponentWithLiterals = CalculationComponent | 'UNKNOWN_CALCULATION_COMPONENT' | 'DISCOUNTS' | 'DELIVERY' | 'TAX' | 'MEMBERSHIPS' | 'GIFT_CARDS';
-declare enum ErrorCode {
-    UNKNOWN_ERROR_CODE = "UNKNOWN_ERROR_CODE"
+interface Details extends DetailsKindOneOf {
+    applicationError?: ApplicationError;
+    validationError?: ValidationError;
+    systemError?: SystemError;
+    /**
+     * deprecated in API's - to enable migration from rendering arbitrary tracing to rest response
+     * @deprecated
+     */
+    tracing?: Record<string, string>;
+}
+/** @oneof */
+interface DetailsKindOneOf {
+    applicationError?: ApplicationError;
+    validationError?: ValidationError;
+    systemError?: SystemError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+/**
+ * example result:
+ * {
+ * "fieldViolations": [
+ * {
+ * "field": "fieldA",
+ * "description": "invalid music note. supported notes: [do,re,mi,fa,sol,la,ti]",
+ * "violatedRule": "OTHER",
+ * "ruleName": "INVALID_NOTE",
+ * "data": {
+ * "value": "FI"
+ * }
+ * },
+ * {
+ * "field": "fieldB",
+ * "description": "field value out of range. supported range: [0-20]",
+ * "violatedRule": "MAX",
+ * "data": {
+ * "threshold": 20
+ * }
+ * },
+ * {
+ * "field": "fieldC",
+ * "description": "invalid phone number. provide a valid phone number of size: [7-12], supported characters: [0-9, +, -, (, )]",
+ * "violatedRule": "FORMAT",
+ * "data": {
+ * "type": "PHONE"
+ * }
+ * }
+ * ]
+ * }
+ */
+interface ValidationError {
+    fieldViolations?: FieldViolation[];
+}
+declare enum RuleType {
+    VALIDATION = "VALIDATION",
+    OTHER = "OTHER",
+    MAX = "MAX",
+    MIN = "MIN",
+    MAX_LENGTH = "MAX_LENGTH",
+    MIN_LENGTH = "MIN_LENGTH",
+    MAX_SIZE = "MAX_SIZE",
+    MIN_SIZE = "MIN_SIZE",
+    FORMAT = "FORMAT",
+    DECIMAL_LTE = "DECIMAL_LTE",
+    DECIMAL_GTE = "DECIMAL_GTE",
+    DECIMAL_LT = "DECIMAL_LT",
+    DECIMAL_GT = "DECIMAL_GT",
+    DECIMAL_MAX_SCALE = "DECIMAL_MAX_SCALE",
+    INVALID_ENUM_VALUE = "INVALID_ENUM_VALUE",
+    REQUIRED_FIELD = "REQUIRED_FIELD",
+    FIELD_NOT_ALLOWED = "FIELD_NOT_ALLOWED",
+    ONE_OF_ALIGNMENT = "ONE_OF_ALIGNMENT",
+    EXACT_LENGTH = "EXACT_LENGTH",
+    EXACT_SIZE = "EXACT_SIZE",
+    REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
 }
 /** @enumType */
-type ErrorCodeWithLiterals = ErrorCode | 'UNKNOWN_ERROR_CODE';
+type RuleTypeWithLiterals = RuleType | 'VALIDATION' | 'OTHER' | 'MAX' | 'MIN' | 'MAX_LENGTH' | 'MIN_LENGTH' | 'MAX_SIZE' | 'MIN_SIZE' | 'FORMAT' | 'DECIMAL_LTE' | 'DECIMAL_GTE' | 'DECIMAL_LT' | 'DECIMAL_GT' | 'DECIMAL_MAX_SCALE' | 'INVALID_ENUM_VALUE' | 'REQUIRED_FIELD' | 'FIELD_NOT_ALLOWED' | 'ONE_OF_ALIGNMENT' | 'EXACT_LENGTH' | 'EXACT_SIZE' | 'REQUIRED_ONE_OF_FIELD';
+interface FieldViolation {
+    field?: string;
+    description?: string;
+    violatedRule?: RuleTypeWithLiterals;
+    /** applicable when violated_rule=OTHER */
+    ruleName?: string | null;
+    data?: Record<string, any> | null;
+}
+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;
@@ -2176,10 +2294,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 */

package/build/internal/cjs/meta.js

@@ -189,6 +189,9 @@ function createCart(payload) {
       method: "POST",
       methodFqn: "wix.ecom.cart.v2.CartService.CreateCart",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEcomCartV2CartServiceUrl({
         protoPath: "/v2/carts",
         data: serializedData,
@@ -239,6 +242,9 @@ function getCart(payload) {
       method: "GET",
       methodFqn: "wix.ecom.cart.v2.CartService.GetCart",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEcomCartV2CartServiceUrl({
         protoPath: "/v2/carts/{cartId}",
         data: payload,
@@ -323,6 +329,9 @@ function updateCart(payload) {
       method: "PATCH",
       methodFqn: "wix.ecom.cart.v2.CartService.UpdateCart",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEcomCartV2CartServiceUrl({
         protoPath: "/v2/carts/{cart.id}",
         data: serializedData,
@@ -373,6 +382,9 @@ function deleteCart(payload) {
       method: "DELETE",
       methodFqn: "wix.ecom.cart.v2.CartService.DeleteCart",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEcomCartV2CartServiceUrl({
         protoPath: "/v2/carts/{cartId}",
         data: payload,
@@ -391,6 +403,9 @@ function refreshCart(payload) {
       method: "POST",
       methodFqn: "wix.ecom.cart.v2.CartService.RefreshCart",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEcomCartV2CartServiceUrl({
         protoPath: "/v2/carts/{cartId}/refresh",
         data: payload,
@@ -441,6 +456,9 @@ function calculateCart(payload) {
       method: "POST",
       methodFqn: "wix.ecom.cart.v2.CartService.CalculateCart",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEcomCartV2CartServiceUrl({
         protoPath: "/v2/carts/{cartId}/calculate",
         data: payload,
@@ -494,6 +512,9 @@ function getCheckoutUrl(payload) {
       method: "POST",
       methodFqn: "wix.ecom.cart.v2.CartService.GetCheckoutURL",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEcomCartV2CartServiceUrl({
         protoPath: "/v2/carts/{cartId}/get-checkout-url",
         data: payload,
@@ -512,6 +533,9 @@ function placeOrder(payload) {
       method: "POST",
       methodFqn: "wix.ecom.cart.v2.CartService.PlaceOrder",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEcomCartV2CartServiceUrl({
         protoPath: "/v2/carts/{cartId}/place-order",
         data: payload,
@@ -554,6 +578,9 @@ function addLineItems(payload) {
       method: "POST",
       methodFqn: "wix.ecom.cart.v2.CartService.AddLineItems",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEcomCartV2CartServiceUrl({
         protoPath: "/v2/carts/{cartId}/add-line-items",
         data: serializedData,
@@ -604,6 +631,9 @@ function removeLineItems(payload) {
       method: "POST",
       methodFqn: "wix.ecom.cart.v2.CartService.RemoveLineItems",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEcomCartV2CartServiceUrl({
         protoPath: "/v2/carts/{cartId}/remove-line-items",
         data: payload,
@@ -654,6 +684,9 @@ function updateLineItems(payload) {
       method: "POST",
       methodFqn: "wix.ecom.cart.v2.CartService.UpdateLineItems",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEcomCartV2CartServiceUrl({
         protoPath: "/v2/carts/{cartId}/update-line-items",
         data: payload,
@@ -704,6 +737,9 @@ function addCoupon(payload) {
       method: "POST",
       methodFqn: "wix.ecom.cart.v2.CartService.AddCoupon",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEcomCartV2CartServiceUrl({
         protoPath: "/v2/carts/{cartId}/add-coupon",
         data: payload,
@@ -754,6 +790,9 @@ function removeCoupon(payload) {
       method: "POST",
       methodFqn: "wix.ecom.cart.v2.CartService.RemoveCoupon",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEcomCartV2CartServiceUrl({
         protoPath: "/v2/carts/{cartId}/remove-coupon",
         data: payload,
@@ -804,6 +843,9 @@ function addGiftCard(payload) {
       method: "POST",
       methodFqn: "wix.ecom.cart.v2.CartService.AddGiftCard",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEcomCartV2CartServiceUrl({
         protoPath: "/v2/carts/{cartId}/add-gift-card",
         data: payload,
@@ -854,6 +896,9 @@ function removeGiftCard(payload) {
       method: "POST",
       methodFqn: "wix.ecom.cart.v2.CartService.RemoveGiftCard",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEcomCartV2CartServiceUrl({
         protoPath: "/v2/carts/{cartId}/remove-gift-card",
         data: payload,
@@ -904,6 +949,9 @@ function markCartAsCompleted(payload) {
       method: "POST",
       methodFqn: "wix.ecom.cart.v2.CartService.MarkCartAsCompleted",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEcomCartV2CartServiceUrl({
         protoPath: "/v2/carts/{cartId}/mark-cart-as-completed",
         data: payload,
@@ -954,6 +1002,9 @@ function handleAsyncCheckoutCompletion(payload) {
       method: "POST",
       methodFqn: "wix.ecom.cart.v2.CartService.HandleAsyncCheckoutCompletion",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEcomCartV2CartServiceUrl({
         protoPath: "/v2/carts/handle-async-checkout-completion",
         data: payload,