@wix/auto_sdk_ecom_current-cart 1.0.174 → 1.0.176

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

@@ -2498,19 +2498,46 @@ interface GiftCardCalculationError {
 interface MembershipOptions {
     /**
      * List of payment options that can be used.
+     * Populated by the legacy ListEligibleMemberships flow.
      * @maxSize 300
+     * @deprecated List of payment options that can be used.
+     * Populated by the legacy ListEligibleMemberships flow.
+     * @replacedBy validated_existing_memberships
+     * @targetRemovalDate 2026-10-01
      */
     eligibleMemberships?: Membership[];
     /**
      * List of payment options that are owned by the member, but cannot be used due to reason provided.
+     * Populated by the legacy ListEligibleMemberships flow.
      * @maxSize 300
+     * @deprecated List of payment options that are owned by the member, but cannot be used due to reason provided.
+     * Populated by the legacy ListEligibleMemberships flow.
+     * @replacedBy validated_existing_memberships
+     * @targetRemovalDate 2026-10-01
      */
     invalidMemberships?: InvalidMembership[];
     /**
      * The selected membership payment options and which line items they apply to.
+     * Populated by the legacy ListEligibleMemberships flow.
      * @maxSize 300
+     * @deprecated The selected membership payment options and which line items they apply to.
+     * Populated by the legacy ListEligibleMemberships flow.
+     * @replacedBy validated_existing_memberships
+     * @targetRemovalDate 2026-10-01
      */
     selectedMemberships?: HostSelectedMembership[];
+    /**
+     * Validated existing memberships selected for redemption, each with the line items it can cover.
+     * Populated by the EnhanceAndValidateSelection flow.
+     * @internal
+     */
+    validatedExistingMemberships?: ValidatedExistingMemberships;
+    /**
+     * Validated future plans (purchasable during this checkout) and how their benefits cover the line items.
+     * Populated by the EnhanceAndValidateSelection flow.
+     * @internal
+     */
+    validatedPurchasablePlans?: ValidatedPurchasablePlans;
 }
 interface Membership {
     /**
@@ -2556,17 +2583,6 @@ interface Membership {
      * @maxLength 500
      */
     offeringDescription?: string | null;
-    /**
-     * Deprecated. A membership is a single benefit of a paid plan and no longer models benefits itself.
-     * What a membership can pay for is exposed by `ListExistingMembershipsResponse.memberships`
-     * (`ExistingMembership.covered_line_items`).
-     * @internal
-     * @maxSize 50
-     * @deprecated
-     * @replacedBy ExistingMembership.covered_line_items
-     * @targetRemovalDate 2026-07-30
-     */
-    benefits?: Benefit[];
 }
 interface MembershipName {
     /**
@@ -2611,10 +2627,147 @@ declare enum BalanceType {
 }
 /** @enumType */
 type BalanceTypeWithLiterals = BalanceType | 'PUNCH_CARD' | 'CREDIT';
+interface InvalidMembership {
+    /** Membership details. */
+    membership?: Membership;
+    /**
+     * Reason why this membership is invalid and cannot be used.
+     * @minLength 1
+     * @maxLength 100
+     */
+    reason?: string;
+}
+/** Same shape as `ListExistingMembershipsResponse.memberships`. */
+interface ValidatedExistingMemberships {
+    /**
+     * The selected memberships, each paired with the line items it can redeem and the cost to redeem each.
+     * @maxSize 300
+     */
+    memberships?: ExistingMembership[];
+}
+/**
+ * A membership the member already owns, together with the input line items it can pay for.
+ *
+ * A membership is a single benefit granted by a plan the member has already paid for, so coverage is
+ * nested here per membership (no `benefit_id` linkage is needed, unlike a plan that grants many benefits).
+ */
+interface ExistingMembership {
+    /** The membership the member owns. */
+    membership?: V1Membership;
+    /**
+     * The input line items this membership can pay for, and the cost to redeem each.
+     * @maxSize 300
+     */
+    coveredLineItems?: CoveredLineItem[];
+}
+interface V1Membership {
+    /**
+     * Membership ID.
+     * @minLength 1
+     * @maxLength 100
+     */
+    _id?: string;
+    /** Membership name. */
+    name?: MembershipName;
+    /**
+     * Deprecated. Use `ExistingMembership.covered_line_items` to see which line items this membership covers.
+     * @minSize 1
+     * @maxSize 300
+     * @minLength 1
+     * @maxLength 100
+     * @deprecated
+     * @replacedBy ExistingMembership.covered_line_items.line_item_id
+     * @targetRemovalDate 2026-07-30
+     */
+    lineItemIds?: string[];
+    /** Membership's payment credits (balance information). */
+    credits?: MembershipPaymentCredits;
+    /**
+     * Membership expiration date.
+     * @deprecated
+     * @replacedBy offering_description
+     * @targetRemovalDate 2026-07-30
+     */
+    expirationDate?: Date | null;
+    /**
+     * Deprecated. Use `offering_description` for human-readable provider data.
+     * @deprecated
+     * @replacedBy offering_description
+     * @targetRemovalDate 2026-07-30
+     */
+    additionalData?: Record<string, any> | null;
+    /**
+     * Human-readable offering summary for display (for example price and validity text). Provider-supplied.
+     * @internal
+     * @maxLength 500
+     */
+    offeringDescription?: string | null;
+}
+/** A line item a membership can pay for, and the cost to redeem it. */
+interface CoveredLineItem {
+    /**
+     * The input line item this membership can cover.
+     * @minLength 1
+     * @maxLength 100
+     */
+    lineItemId?: string;
+    /**
+     * The amount to redeem from the membership's benefit quota (`benefit.limited_quota.remaining`) for this item.
+     * Always 0 when the benefit is unlimited (nothing is decremented).
+     */
+    redemptionCost?: number;
+}
+/** Same shape as `ListPurchasablePlansResponse`. */
+interface ValidatedPurchasablePlans {
+    /**
+     * The selected plans.
+     * @maxSize 300
+     */
+    purchasablePlans?: PurchasablePlan[];
+    /**
+     * How the plans' benefits cover the line items, linked to a benefit by `benefit_id`.
+     * @maxSize 300
+     */
+    coverages?: LineItemCoverage[];
+}
+interface PurchasablePlan {
+    /** Catalog and item reference for the plan that can be purchased. */
+    catalogReference?: CatalogReference;
+    /** Plan name. */
+    name?: MembershipName;
+    /**
+     * Benefits the plan would grant once purchased. Multiple entries support multi-benefit plans (e.g., a bundle granting separate yoga and pilates credits).
+     * @minSize 1
+     * @maxSize 50
+     */
+    benefits?: Benefit[];
+    /**
+     * Human-readable offering summary for display (for example price and validity text). Provider-supplied.
+     * @maxLength 500
+     */
+    offeringDescription?: string | null;
+    /**
+     * URL the buyer is redirected to in order to collect additional info required to purchase this plan.
+     * @format WEB_URL
+     */
+    infoCollectionUrl?: string | null;
+    /**
+     * Plan price.
+     * @decimalValue options { gte:0, maxScale:3 }
+     */
+    price?: string;
+    /**
+     * Human-readable description of the plan price (for example "First month free, then $20/month").
+     *
+     * `price` is simply the price (useful for sorting or comparison, for example), while this is a
+     * descriptive, display-oriented summary of it.
+     * @maxLength 500
+     */
+    priceDescription?: string | null;
+}
 /**
  * A single redeemable benefit. A purchasable plan grants one or more benefits (`PurchasablePlan.benefits`);
  * once the plan is paid, each benefit becomes its own membership (charged via `membership_id`).
- * (Also present on the deprecated `Membership.benefits`, retained for backward compatibility.)
  */
 interface Benefit extends BenefitQuotaOneOf {
     limitedQuota?: LimitedQuota;
@@ -2668,15 +2821,30 @@ declare enum LimitedQuotaType {
 }
 /** @enumType */
 type LimitedQuotaTypeWithLiterals = LimitedQuotaType | 'PUNCH_CARD' | 'CREDIT';
-interface InvalidMembership {
-    /** Membership details. */
-    membership?: Membership;
+/**
+ * Maps a benefit to a line item it can cover, and at what cost, linked to a benefit by `benefit_id`.
+ * One entry per (benefit, line item). Returned by `ListPurchasablePlans` (alongside `purchasable_plans`).
+ * For the existing-memberships flow the equivalent mapping is `ExistingMembership.covered_line_items`,
+ * which needs no `benefit_id` because a membership is a single benefit.
+ */
+interface LineItemCoverage {
     /**
-     * Reason why this membership is invalid and cannot be used.
+     * The benefit that covers the line item, as returned in `Benefit.benefit_id`.
+     * @minLength 1
+     * @maxLength 200
+     */
+    benefitId?: string;
+    /**
+     * The line item this benefit covers.
      * @minLength 1
      * @maxLength 100
      */
-    reason?: string;
+    lineItemId?: string;
+    /**
+     * The amount to redeem from the benefit's `limited_quota.remaining` value for this item.
+     * Always 0 for an unlimited benefit (nothing is decremented).
+     */
+    redemptionCost?: number;
 }
 interface AdditionalFee {
     /**
@@ -3701,4 +3869,4 @@ interface EstimateCurrentCartTotalsOptions {
  */
 declare function deleteCurrentCart(): Promise<void>;
 
-export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddToCartRequest, type AddToCartResponse, type AddToCurrentCartAndEstimateTotalsRequest, type AddToCurrentCartOptions, type AddToCurrentCartRequest, type AdditionalFee, AdditionalFeeSource, type AdditionalFeeSourceWithLiterals, type Address, type AddressLocation, type AddressWithContact, type AggregatedTaxBreakdown, type ApplicableLineItems, type ApplicationError, type AppliedDiscount, type AppliedDiscountDiscountSourceOneOf, AppliedDiscountDiscountType, type AppliedDiscountDiscountTypeWithLiterals, type AutoTaxFallbackCalculationDetails, BalanceType, type BalanceTypeWithLiterals, type BaseEventMetadata, type Benefit, type BenefitQuotaOneOf, type BillingSettings, type BuyerInfo, type BuyerInfoIdOneOf, type CalculatedItemModifier, type CalculatedLineItem, type CalculationErrors, type CalculationErrorsShippingCalculationErrorOneOf, type Carrier, type CarrierError, type CarrierErrors, type CarrierServiceOption, type Cart, type CartCreatedEnvelope, type CartDeletedEnvelope, type CartDiscount, type CartDiscountDiscountSourceOneOf, type CartUpdatedEnvelope, type CatalogOverrideFields, type CatalogReference, ChannelType, type ChannelTypeWithLiterals, ChargeType, type ChargeTypeWithLiterals, type Color, type Coupon, type CreateCartRequest, type CreateCartResponse, type CreateCheckoutFromCurrentCartOptions, type CreateCheckoutFromCurrentCartRequest, type CreateCheckoutRequest, type CreateCheckoutResponse, type CustomLineItem, type DeleteCartRequest, type DeleteCartResponse, type DeleteCurrentCartRequest, type DeliveryAllocation, type DeliveryLogistics, type DeliveryTimeSlot, type Description, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type Details, type DetailsKindOneOf, type Dimensions, DimensionsUnit, type DimensionsUnitWithLiterals, type DiscountRule, type DiscountRuleName, DiscountType, type DiscountTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EstimateCurrentCartTotalsOptions, type EstimateCurrentCartTotalsRequest, type EstimateTotalsRequest, type EstimateTotalsResponse, type EventMetadata, type ExtendedFields, FallbackReason, type FallbackReasonWithLiterals, type FieldViolation, FileType, type FileTypeWithLiterals, type FocalPoint, type FreeTrialPeriod, type FullAddressContactDetails, type GetCartByCheckoutIdRequest, type GetCartByCheckoutIdResponse, type GetCartRequest, type GetCartResponse, type GetCurrentCartApplicationErrors, type GetCurrentCartRequest, type GetCurrentCartResponse, type GiftCard, type GiftCardCalculationError, type Group, type HostSelectedMembership, type IdentificationData, type IdentificationDataIdOneOf, type InvalidMembership, type ItemAvailabilityInfo, ItemAvailabilityStatus, type ItemAvailabilityStatusWithLiterals, type ItemCombination, type ItemCombinationLineItem, type ItemModifier, type ItemTaxFullDetails, type ItemType, type ItemTypeItemTypeDataOneOf, ItemTypePreset, type ItemTypePresetWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LimitedQuota, LimitedQuotaType, type LimitedQuotaTypeWithLiterals, type LineItem, type LineItemAdded, type LineItemDiscount, type LineItemPricesData, type LineItemQuantityUpdate, ManualCalculationReason, type ManualCalculationReasonWithLiterals, type Membership, type MembershipName, type MembershipOptions, type MembershipPaymentCredits, type MerchantDiscount, type MessageEnvelope, type ModifierGroup, type MultiCurrencyPrice, NameInLineItem, type NameInLineItemWithLiterals, NameInOther, type NameInOtherWithLiterals, type Other, type OtherCharge, type PaymentOption, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PhysicalProperties, type PickupDetails, PickupMethod, type PickupMethodWithLiterals, type PlainTextValue, type PlatformFee, PlatformFeeChargeType, type PlatformFeeChargeTypeWithLiterals, type Policy, type PriceDescription, type PriceSummary, type ProductName, ProductPeriodAlignment, type ProductPeriodAlignmentWithLiterals, QuotaType, type QuotaTypeWithLiterals, RateType, type RateTypeWithLiterals, type Region, type RemoveBusinessLocationRequest, type RemoveBusinessLocationResponse, type RemoveCouponFromCurrentCartRequest, type RemoveCouponRequest, type RemoveCouponResponse, type RemoveLineItemsFromCurrentCartRequest, type RemoveLineItemsRequest, type RemoveLineItemsResponse, type RestoreInfo, RuleType, type RuleTypeWithLiterals, type Scope, type SecuredMedia, type SelectedCarrierServiceOption, type SelectedCarrierServiceOptionOtherCharge, type SelectedCarrierServiceOptionPrices, type SelectedMembership, type SelectedMemberships, type SelectedShippingOption, type ServiceProperties, Severity, type SeverityWithLiterals, type ShippingInformation, type ShippingOption, type ShippingPrice, type ShippingRegion, type StreetAddress, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionOptionInfo, type SubscriptionSettings, SuggestedFix, type SuggestedFixWithLiterals, type SystemError, type Target, type TargetLineItem, type TargetTargetTypeOneOf, type TaxBreakdown, type TaxCalculationDetails, type TaxCalculationDetailsCalculationDetailsOneOf, type TaxRateBreakdown, type TaxSummary, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type Title, type TranslatableString, type UpdateCartRequest, type UpdateCartResponse, type UpdateCurrentCartLineItemQuantityRequest, type UpdateCurrentCartOptions, type UpdateLineItemsQuantityRequest, type UpdateLineItemsQuantityResponse, type V1Coupon, type V1DiscountRule, type V1DiscountRuleName, type V1ItemModifier, type V1MerchantDiscount, type V1ModifierGroup, type ValidationError, type VatId, VatType, type VatTypeWithLiterals, type Violation, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, addToCurrentCart, createCheckoutFromCurrentCart, deleteCurrentCart, estimateCurrentCartTotals, getCurrentCart, onCartCreated, onCartDeleted, onCartUpdated, removeCouponFromCurrentCart, removeLineItemsFromCurrentCart, updateCurrentCart, updateCurrentCartLineItemQuantity };
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddToCartRequest, type AddToCartResponse, type AddToCurrentCartAndEstimateTotalsRequest, type AddToCurrentCartOptions, type AddToCurrentCartRequest, type AdditionalFee, AdditionalFeeSource, type AdditionalFeeSourceWithLiterals, type Address, type AddressLocation, type AddressWithContact, type AggregatedTaxBreakdown, type ApplicableLineItems, type ApplicationError, type AppliedDiscount, type AppliedDiscountDiscountSourceOneOf, AppliedDiscountDiscountType, type AppliedDiscountDiscountTypeWithLiterals, type AutoTaxFallbackCalculationDetails, BalanceType, type BalanceTypeWithLiterals, type BaseEventMetadata, type Benefit, type BenefitQuotaOneOf, type BillingSettings, type BuyerInfo, type BuyerInfoIdOneOf, type CalculatedItemModifier, type CalculatedLineItem, type CalculationErrors, type CalculationErrorsShippingCalculationErrorOneOf, type Carrier, type CarrierError, type CarrierErrors, type CarrierServiceOption, type Cart, type CartCreatedEnvelope, type CartDeletedEnvelope, type CartDiscount, type CartDiscountDiscountSourceOneOf, type CartUpdatedEnvelope, type CatalogOverrideFields, type CatalogReference, ChannelType, type ChannelTypeWithLiterals, ChargeType, type ChargeTypeWithLiterals, type Color, type Coupon, type CoveredLineItem, type CreateCartRequest, type CreateCartResponse, type CreateCheckoutFromCurrentCartOptions, type CreateCheckoutFromCurrentCartRequest, type CreateCheckoutRequest, type CreateCheckoutResponse, type CustomLineItem, type DeleteCartRequest, type DeleteCartResponse, type DeleteCurrentCartRequest, type DeliveryAllocation, type DeliveryLogistics, type DeliveryTimeSlot, type Description, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type Details, type DetailsKindOneOf, type Dimensions, DimensionsUnit, type DimensionsUnitWithLiterals, type DiscountRule, type DiscountRuleName, DiscountType, type DiscountTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EstimateCurrentCartTotalsOptions, type EstimateCurrentCartTotalsRequest, type EstimateTotalsRequest, type EstimateTotalsResponse, type EventMetadata, type ExistingMembership, type ExtendedFields, FallbackReason, type FallbackReasonWithLiterals, type FieldViolation, FileType, type FileTypeWithLiterals, type FocalPoint, type FreeTrialPeriod, type FullAddressContactDetails, type GetCartByCheckoutIdRequest, type GetCartByCheckoutIdResponse, type GetCartRequest, type GetCartResponse, type GetCurrentCartApplicationErrors, type GetCurrentCartRequest, type GetCurrentCartResponse, type GiftCard, type GiftCardCalculationError, type Group, type HostSelectedMembership, type IdentificationData, type IdentificationDataIdOneOf, type InvalidMembership, type ItemAvailabilityInfo, ItemAvailabilityStatus, type ItemAvailabilityStatusWithLiterals, type ItemCombination, type ItemCombinationLineItem, type ItemModifier, type ItemTaxFullDetails, type ItemType, type ItemTypeItemTypeDataOneOf, ItemTypePreset, type ItemTypePresetWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LimitedQuota, LimitedQuotaType, type LimitedQuotaTypeWithLiterals, type LineItem, type LineItemAdded, type LineItemCoverage, type LineItemDiscount, type LineItemPricesData, type LineItemQuantityUpdate, ManualCalculationReason, type ManualCalculationReasonWithLiterals, type Membership, type MembershipName, type MembershipOptions, type MembershipPaymentCredits, type MerchantDiscount, type MessageEnvelope, type ModifierGroup, type MultiCurrencyPrice, NameInLineItem, type NameInLineItemWithLiterals, NameInOther, type NameInOtherWithLiterals, type Other, type OtherCharge, type PaymentOption, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PhysicalProperties, type PickupDetails, PickupMethod, type PickupMethodWithLiterals, type PlainTextValue, type PlatformFee, PlatformFeeChargeType, type PlatformFeeChargeTypeWithLiterals, type Policy, type PriceDescription, type PriceSummary, type ProductName, ProductPeriodAlignment, type ProductPeriodAlignmentWithLiterals, type PurchasablePlan, QuotaType, type QuotaTypeWithLiterals, RateType, type RateTypeWithLiterals, type Region, type RemoveBusinessLocationRequest, type RemoveBusinessLocationResponse, type RemoveCouponFromCurrentCartRequest, type RemoveCouponRequest, type RemoveCouponResponse, type RemoveLineItemsFromCurrentCartRequest, type RemoveLineItemsRequest, type RemoveLineItemsResponse, type RestoreInfo, RuleType, type RuleTypeWithLiterals, type Scope, type SecuredMedia, type SelectedCarrierServiceOption, type SelectedCarrierServiceOptionOtherCharge, type SelectedCarrierServiceOptionPrices, type SelectedMembership, type SelectedMemberships, type SelectedShippingOption, type ServiceProperties, Severity, type SeverityWithLiterals, type ShippingInformation, type ShippingOption, type ShippingPrice, type ShippingRegion, type StreetAddress, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionOptionInfo, type SubscriptionSettings, SuggestedFix, type SuggestedFixWithLiterals, type SystemError, type Target, type TargetLineItem, type TargetTargetTypeOneOf, type TaxBreakdown, type TaxCalculationDetails, type TaxCalculationDetailsCalculationDetailsOneOf, type TaxRateBreakdown, type TaxSummary, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type Title, type TranslatableString, type UpdateCartRequest, type UpdateCartResponse, type UpdateCurrentCartLineItemQuantityRequest, type UpdateCurrentCartOptions, type UpdateLineItemsQuantityRequest, type UpdateLineItemsQuantityResponse, type V1Coupon, type V1DiscountRule, type V1DiscountRuleName, type V1ItemModifier, type V1Membership, type V1MerchantDiscount, type V1ModifierGroup, type ValidatedExistingMemberships, type ValidatedPurchasablePlans, type ValidationError, type VatId, VatType, type VatTypeWithLiterals, type Violation, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, addToCurrentCart, createCheckoutFromCurrentCart, deleteCurrentCart, estimateCurrentCartTotals, getCurrentCart, onCartCreated, onCartDeleted, onCartUpdated, removeCouponFromCurrentCart, removeLineItemsFromCurrentCart, updateCurrentCart, updateCurrentCartLineItemQuantity };

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

@@ -580,6 +580,9 @@ function estimateCurrentCartTotals(payload) {
             { path: "membershipOptions.eligibleMemberships.expirationDate" },
             {
               path: "membershipOptions.invalidMemberships.membership.expirationDate"
+            },
+            {
+              path: "membershipOptions.validatedExistingMemberships.memberships.membership.expirationDate"
             }
           ]
         },