@wix/auto_sdk_ecom_cart 1.0.159 → 1.0.161

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

@@ -2367,18 +2367,33 @@ interface Membership {
     /** The name of this membership. */
     name?: MembershipName;
     /**
-     * Line item IDs which are "paid" for by this membership.
+     * Deprecated. Use the response-level `coverages` (`LineItemCoverage`) to see which line items each benefit covers.
      * @minSize 1
      * @maxSize 300
      * @minLength 1
      * @maxLength 100
      */
     lineItemIds?: string[];
-    /** Optional - For a membership that has limited credits, information about credit usage. */
+    /**
+     * Deprecated. Use `benefits`.
+     * @deprecated
+     * @replacedBy benefits
+     * @targetRemovalDate 2026-07-30
+     */
     credits?: MembershipPaymentCredits;
-    /** Optional - TMembership expiry date. */
+    /**
+     * Deprecated. Use `offering_description`.
+     * @deprecated
+     * @replacedBy offering_description
+     * @targetRemovalDate 2026-07-30
+     */
     expirationDate?: Date | null;
-    /** Additional data about this membership. */
+    /**
+     * Deprecated. Use `benefits.additional_data`.
+     * @deprecated
+     * @replacedBy benefits
+     * @targetRemovalDate 2026-07-30
+     */
     additionalData?: Record<string, any> | null;
 }
 interface MembershipName {
@@ -2410,6 +2425,62 @@ declare enum BalanceType {
 }
 /** @enumType */
 type BalanceTypeWithLiterals = BalanceType | 'PUNCH_CARD' | 'CREDIT';
+/**
+ * A single redeemable benefit granted by a membership or a purchasable plan.
+ * Used by the per-benefit redemption flow (`ListExistingMemberships`, `ListPurchasablePlans`, `EnhanceAndValidateSelection`).
+ */
+interface Benefit extends BenefitQuotaOneOf {
+    limitedQuota?: LimitedQuota;
+    /**
+     * Identifier for this benefit. Must be unique within the response so the response-level `coverages`
+     * (`LineItemCoverage.benefit_id`) can reference it unambiguously across memberships/plans.
+     * @minLength 1
+     * @maxLength 200
+     */
+    benefitId?: string;
+    /**
+     * Human-readable label for this benefit (for example, "Manicure" or "Pedicure" on multi-set punchcards).
+     * @maxLength 200
+     */
+    label?: string | null;
+    /**
+     * The kind of quota this benefit grants: a countable amount drawn down on redemption (`LIMITED`),
+     * or an unbounded amount that is never drawn down (`UNLIMITED`).
+     */
+    quotaType?: QuotaTypeWithLiterals;
+}
+/** @oneof */
+interface BenefitQuotaOneOf {
+    limitedQuota?: LimitedQuota;
+}
+declare enum QuotaType {
+    /** The benefit grants a countable quota that is drawn down on redemption. */
+    LIMITED = "LIMITED",
+    /** The benefit is unlimited (unbounded) and is never drawn down. */
+    UNLIMITED = "UNLIMITED"
+}
+/** @enumType */
+type QuotaTypeWithLiterals = QuotaType | 'LIMITED' | 'UNLIMITED';
+/** A limited, countable redeemable amount. */
+interface LimitedQuota {
+    /**
+     * The quota's initial value.
+     * @min 1
+     */
+    total?: number;
+    /** The quota's remaining value. */
+    remaining?: number;
+    /** How the quota is measured. */
+    limitedQuotaType?: LimitedQuotaTypeWithLiterals;
+}
+declare enum LimitedQuotaType {
+    /** Quota is measured in discrete uses (e.g., sessions, visits). */
+    PUNCH_CARD = "PUNCH_CARD",
+    /** Quota is measured in a currency-like value (e.g., points). */
+    CREDIT = "CREDIT"
+}
+/** @enumType */
+type LimitedQuotaTypeWithLiterals = LimitedQuotaType | 'PUNCH_CARD' | 'CREDIT';
 interface InvalidMembership {
     /** Membership details. */
     membership?: Membership;
@@ -3620,4 +3691,4 @@ declare function deleteCart(_id: string): Promise<void>;
  */
 declare function removeBusinessLocation(_id: string): Promise<NonNullablePaths<RemoveBusinessLocationResponse, `cart.lineItems` | `cart.lineItems.${number}.quantity` | `cart.lineItems.${number}.catalogReference.catalogItemId` | `cart.lineItems.${number}.catalogReference.appId` | `cart.lineItems.${number}.productName.original` | `cart.lineItems.${number}.price.amount` | `cart.lineItems.${number}.price.convertedAmount` | `cart.lineItems.${number}.price.formattedAmount` | `cart.lineItems.${number}.price.formattedConvertedAmount` | `cart.lineItems.${number}.availability.status` | `cart.lineItems.${number}.physicalProperties.shippable` | `cart.lineItems.${number}.itemType.preset` | `cart.lineItems.${number}.itemType.custom` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.frequency` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.autoRenewal` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.enableCustomerCancellation` | `cart.lineItems.${number}.subscriptionOptionInfo.title.original` | `cart.lineItems.${number}.subscriptionOptionInfo.description.original` | `cart.lineItems.${number}.paymentOption` | `cart.lineItems.${number}.priceDescription.original` | `cart.lineItems.${number}.selectedMembership._id` | `cart.lineItems.${number}.selectedMembership.appId` | `cart.lineItems.${number}.customLineItem` | `cart.lineItems.${number}.priceUndetermined` | `cart.lineItems.${number}.fixedQuantity` | `cart.lineItems.${number}.catalogOverrideFields.paymentOption.value` | `cart.lineItems.${number}.savePaymentMethod` | `cart.lineItems.${number}.taxableAddress.addressType` | `cart.lineItems.${number}.membersOnly` | `cart.buyerInfo.visitorId` | `cart.buyerInfo.memberId` | `cart.buyerInfo.userId` | `cart.currency` | `cart.conversionCurrency` | `cart.weightUnit` | `cart.appliedDiscounts` | `cart.appliedDiscounts.${number}.coupon._id` | `cart.appliedDiscounts.${number}.coupon.code` | `cart.contactInfo.address.streetAddress.number` | `cart.contactInfo.address.streetAddress.name` | `cart.contactInfo.contactDetails.vatId._id` | `cart.contactInfo.contactDetails.vatId.type` | `cart.selectedShippingOption.code` | `cart.paymentCurrency`, 7>>;
 
-export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddToCartApplicationErrors, type AddToCartOptions, type AddToCartRequest, type AddToCartResponse, type AddToCurrentCartAndEstimateTotalsRequest, 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 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 CreateCartApplicationErrors, type CreateCartOptions, type CreateCartRequest, type CreateCartResponse, type CreateCheckoutApplicationErrors, type CreateCheckoutFromCurrentCartRequest, type CreateCheckoutOptions, 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 EstimateCurrentCartTotalsRequest, type EstimateTotalsOptions, 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 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 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, 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 UpdateCartApplicationErrors, type UpdateCartOptions, type UpdateCartRequest, type UpdateCartResponse, type UpdateCurrentCartLineItemQuantityRequest, 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, addToCart, createCart, createCheckout, deleteCart, estimateTotals, getCart, onCartCreated, onCartDeleted, onCartUpdated, removeBusinessLocation, removeCoupon, removeLineItems, updateCart, updateLineItemsQuantity };
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddToCartApplicationErrors, type AddToCartOptions, type AddToCartRequest, type AddToCartResponse, type AddToCurrentCartAndEstimateTotalsRequest, 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 CreateCartApplicationErrors, type CreateCartOptions, type CreateCartRequest, type CreateCartResponse, type CreateCheckoutApplicationErrors, type CreateCheckoutFromCurrentCartRequest, type CreateCheckoutOptions, 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 EstimateCurrentCartTotalsRequest, type EstimateTotalsOptions, 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 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 UpdateCartApplicationErrors, type UpdateCartOptions, type UpdateCartRequest, type UpdateCartResponse, type UpdateCurrentCartLineItemQuantityRequest, 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, addToCart, createCart, createCheckout, deleteCart, estimateTotals, getCart, onCartCreated, onCartDeleted, onCartUpdated, removeBusinessLocation, removeCoupon, removeLineItems, updateCart, updateLineItemsQuantity };

package/build/cjs/index.typings.js

@@ -33,6 +33,7 @@ __export(index_typings_exports, {
   ItemAvailabilityStatus: () => ItemAvailabilityStatus,
   ItemTypePreset: () => ItemTypePreset,
   JurisdictionType: () => JurisdictionType,
+  LimitedQuotaType: () => LimitedQuotaType,
   ManualCalculationReason: () => ManualCalculationReason,
   NameInLineItem: () => NameInLineItem,
   NameInOther: () => NameInOther,
@@ -40,6 +41,7 @@ __export(index_typings_exports, {
   PickupMethod: () => PickupMethod,
   PlatformFeeChargeType: () => PlatformFeeChargeType,
   ProductPeriodAlignment: () => ProductPeriodAlignment,
+  QuotaType: () => QuotaType,
   RateType: () => RateType,
   RuleType: () => RuleType,
   Severity: () => Severity,
@@ -1062,6 +1064,16 @@ var BalanceType = /* @__PURE__ */ ((BalanceType2) => {
   BalanceType2["CREDIT"] = "CREDIT";
   return BalanceType2;
 })(BalanceType || {});
+var QuotaType = /* @__PURE__ */ ((QuotaType2) => {
+  QuotaType2["LIMITED"] = "LIMITED";
+  QuotaType2["UNLIMITED"] = "UNLIMITED";
+  return QuotaType2;
+})(QuotaType || {});
+var LimitedQuotaType = /* @__PURE__ */ ((LimitedQuotaType2) => {
+  LimitedQuotaType2["PUNCH_CARD"] = "PUNCH_CARD";
+  LimitedQuotaType2["CREDIT"] = "CREDIT";
+  return LimitedQuotaType2;
+})(LimitedQuotaType || {});
 var AdditionalFeeSource = /* @__PURE__ */ ((AdditionalFeeSource2) => {
   AdditionalFeeSource2["UNKNOWN_ADDITIONAL_FEE_SOURCE"] = "UNKNOWN_ADDITIONAL_FEE_SOURCE";
   AdditionalFeeSource2["SERVICE_PLUGIN"] = "SERVICE_PLUGIN";
@@ -1750,6 +1762,7 @@ async function removeBusinessLocation2(_id) {
   ItemAvailabilityStatus,
   ItemTypePreset,
   JurisdictionType,
+  LimitedQuotaType,
   ManualCalculationReason,
   NameInLineItem,
   NameInOther,
@@ -1757,6 +1770,7 @@ async function removeBusinessLocation2(_id) {
   PickupMethod,
   PlatformFeeChargeType,
   ProductPeriodAlignment,
+  QuotaType,
   RateType,
   RuleType,
   Severity,