@wix/auto_sdk_ecom_current-cart-v-2 1.0.3 → 1.0.5

package/build/cjs/index.d.ts

@@ -722,7 +722,7 @@ interface ItemPaymentConfig {
      * Must be used with `lineItem.paymentOption` set to `MEMBERSHIP` or `MEMBERSHIP_OFFLINE`.
      * This field can be empty when `lineItem.paymentOption` is set to `MEMBERSHIP_OFFLINE`.
      */
-    selectedMembership?: V2SelectedMembership;
+    selectedMembership?: SelectedMembership;
     /**
      * Type of selected payment option for current item.
      *
@@ -730,7 +730,7 @@ interface ItemPaymentConfig {
      */
     paymentOption?: PaymentOptionTypeWithLiterals;
 }
-interface V2SelectedMembership {
+interface SelectedMembership {
     /**
      * Membership ID.
      * @minLength 1
@@ -1569,6 +1569,9 @@ interface V2AdditionalFee {
 interface TaxSummary {
     /**
      * List of taxes applied to the cart.
+     * May contain multiple entries when advanced tax rates are configured by the merchant,
+     * or a single entry representing the total tax amount.
+     * For more details on advanced tax rates, read [this article](https://support.wix.com/en/article/setting-up-tax-calculation-using-the-manual-method#step-3-optional-customize-advanced-mode-settings).
      * @maxSize 100
      */
     taxes?: Tax[];
@@ -1599,7 +1602,7 @@ interface Tax {
      * Tax rate %, as a decimal point between 0 and 1.
      * @decimalValue options { gte:0, lte:1, maxScale:6 }
      */
-    rate?: string;
+    rate?: string | null;
     /** Calculated tax, based on `taxable_amount` and `rate`. */
     totalTax?: MultiCurrencyPrice;
 }
@@ -1625,7 +1628,7 @@ interface AdditionalFeeTax {
 interface PriceSummary {
     /**
      * Total price of all line items after applying item-level discounts.
-     * Before tax TODO: Change it to include tax if the 'prices_include_tax' flag is true.
+     * Includes tax if `tax_summary.prices_include_tax` is true.
      */
     subtotal?: MultiCurrencyPrice;
     /**
@@ -1636,12 +1639,12 @@ interface PriceSummary {
     discount?: MultiCurrencyPrice;
     /**
      * Final delivery cost for the cart.
-     * Before tax TODO: Change it to include tax if the 'prices_include_tax' flag is true.
+     * Includes tax if `tax_summary.prices_include_tax` is true.
      */
     delivery?: MultiCurrencyPrice;
     /**
      * Total additional fees associated with the cart.
-     * Before tax TODO: Change it to include tax if the 'prices_include_tax' flag is true.
+     * Includes tax if `tax_summary.prices_include_tax` is true.
      */
     additionalFees?: MultiCurrencyPrice;
     /** Total tax amount calculated across all applicable components (items, discounts, delivery, and fees). */
@@ -1660,7 +1663,12 @@ interface PaymentSummary {
      * A list of valid memberships that will be charged as part of the order.
      * @maxSize 300
      */
-    memberships?: SelectedMembership[];
+    memberships?: Membership[];
+    /**
+     * Charges information for each subscription in the checkout.
+     * @maxSize 100
+     */
+    subscriptionCharges?: SubscriptionCharges[];
     /** Indicates whether a remaining payment is required to create the order, after applying gift cards. */
     requiresPaymentAfterGiftCard?: boolean;
     /** The total amount due after applying all gift cards. */
@@ -1681,7 +1689,7 @@ interface GiftCardSummary {
     /** The amount to be reduced from the gift card's balance. */
     redeemAmount?: MultiCurrencyPrice;
 }
-interface SelectedMembership {
+interface Membership {
     /**
      * Membership ID.
      * @minLength 1
@@ -1701,6 +1709,38 @@ interface SelectedMembership {
      * @maxLength 100
      */
     lineItemIds?: string[];
+    /** The name of this membership. */
+    name?: TranslatableString;
+}
+interface SubscriptionCharges {
+    /**
+     * ids of the items the subscription is defined on
+     * @format GUID
+     * @minSize 1
+     * @maxSize 300
+     */
+    lineItemIds?: string[];
+    /**
+     * Generated description explaining future charges amount and schedule.
+     * Translated to subscription order buyer language, or to site language if was not provided.
+     * @maxLength 1000
+     */
+    description?: string | null;
+    /**
+     * Charges for subscription.
+     * @maxSize 50
+     */
+    charges?: Charge[];
+}
+interface Charge {
+    /** The cycle number from which the charge starts. */
+    cycleFrom?: number;
+    /** The number of cycles for which the charge is applicable. */
+    cycleCount?: number | null;
+    /** Charge summary. */
+    priceSummary?: PriceSummary;
+    /** The billing date from which the charge starts. */
+    cycleBillingDate?: Date | null;
 }
 interface CalculationError {
     /** The calculation component that caused the error. */
@@ -1940,7 +1980,7 @@ interface CatalogItemInput {
      */
     quantity?: number;
     /** Selected membership to be used as payment for this item. */
-    selectedMembership?: V2SelectedMembership;
+    selectedMembership?: SelectedMembership;
     /**
      * Overriding values for catalog item properties.
      * To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
@@ -2238,7 +2278,7 @@ interface SelectedMembershipUpdate {
      *
      * To just remove current selected membership, and not replace with a new one, pass an empty value here.
      */
-    newMembership?: V2SelectedMembership;
+    newMembership?: SelectedMembership;
 }
 interface UpdateLineItemsInCurrentCartResponse {
     /** Updated Cart. */
@@ -2839,4 +2879,4 @@ interface UpdateLineItemsInCurrentCartOptions {
     lineItems?: LineItemUpdate[];
 }
 
-export { type ActionEvent, type AddDiscountRequest, type AddDiscountResponse, type AddDiscountToCurrentCartRequest, type AddDiscountToCurrentCartResponse, type AddGiftCardRequest, type AddGiftCardResponse, type AddGiftCardToCurrentCartRequest, type AddGiftCardToCurrentCartResponse, type AddLineItemsRequest, type AddLineItemsResponse, type AddLineItemsToCurrentCartOptions, type AddLineItemsToCurrentCartRequest, type AddLineItemsToCurrentCartResponse, type AdditionalFee, type AdditionalFeeTax, type Address, type AddressLocation, type ApplicationError, type BusinessInfo, type CalculateCartRequest, type CalculateCartResponse, type CalculateCurrentCartOptions, 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 Color, type CreateCartRequest, type CreateCartResponse, type CreateCurrentCartOptions, 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, DiscountStatus, type DiscountStatusWithLiterals, 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 GetCurrentCartRequest, type GetCurrentCartResponse, type GiftCard, type GiftCardSummary, type Group, type HandleAsyncCheckoutCompletionRequest, type HeadersEntry, type IdentificationData, type IdentificationDataIdOneOf, type ItemAttributes, type ItemDeliveryConfig, 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 LineItem, type LineItemSummary, type LineItemTax, type LineItemUpdate, type MarkCartAsCompletedRequest, type MarkCartAsCompletedResponse, 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 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 RemoveDiscountFromCurrentCartRequest, type RemoveDiscountFromCurrentCartResponse, type RemoveDiscountRequest, type RemoveDiscountResponse, 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, 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 UpdateCartRequest, type UpdateCartResponse, type UpdateCurrentCartRequest, type UpdateCurrentCartResponse, type UpdateLineItemsInCurrentCartOptions, type UpdateLineItemsInCurrentCartRequest, type UpdateLineItemsInCurrentCartResponse, type UpdateLineItemsRequest, type UpdateLineItemsResponse, type V2AdditionalFee, type V2LineItem, type V2SelectedMembership, type ValidationError, ValidationsConfig, type ValidationsConfigWithLiterals, type VatId, VatType, type VatTypeWithLiterals, type Violation, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals };
+export { type ActionEvent, type AddDiscountRequest, type AddDiscountResponse, type AddDiscountToCurrentCartRequest, type AddDiscountToCurrentCartResponse, type AddGiftCardRequest, type AddGiftCardResponse, type AddGiftCardToCurrentCartRequest, type AddGiftCardToCurrentCartResponse, type AddLineItemsRequest, type AddLineItemsResponse, type AddLineItemsToCurrentCartOptions, type AddLineItemsToCurrentCartRequest, type AddLineItemsToCurrentCartResponse, type AdditionalFee, type AdditionalFeeTax, type Address, type AddressLocation, type ApplicationError, type BusinessInfo, type CalculateCartRequest, type CalculateCartResponse, type CalculateCurrentCartOptions, 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 CreateCartRequest, type CreateCartResponse, type CreateCurrentCartOptions, 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, DiscountStatus, type DiscountStatusWithLiterals, 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 GetCurrentCartRequest, type GetCurrentCartResponse, type GiftCard, type GiftCardSummary, type Group, type HandleAsyncCheckoutCompletionRequest, type HeadersEntry, type IdentificationData, type IdentificationDataIdOneOf, type ItemAttributes, type ItemDeliveryConfig, 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 LineItem, type LineItemSummary, type LineItemTax, type LineItemUpdate, 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 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 RemoveDiscountFromCurrentCartRequest, type RemoveDiscountFromCurrentCartResponse, type RemoveDiscountRequest, type RemoveDiscountResponse, 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 UpdateCartRequest, type UpdateCartResponse, type UpdateCurrentCartRequest, type UpdateCurrentCartResponse, type UpdateLineItemsInCurrentCartOptions, type UpdateLineItemsInCurrentCartRequest, type UpdateLineItemsInCurrentCartResponse, 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

@@ -483,6 +483,9 @@ function calculateCurrentCart(payload) {
             },
             {
               path: "cart.lineItems.attributes.serviceProperties.scheduledDate"
+            },
+            {
+              path: "summary.paymentSummary.subscriptionCharges.charges.cycleBillingDate"
             }
           ]
         },