@wix/auto_sdk_ecom_cart 1.0.180 → 1.0.182

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

@@ -2407,29 +2407,31 @@ interface Membership {
 }
 interface MembershipName {
     /**
-     * Membership name.
+     * Membership name in the site's original language.
      * @maxLength 100
      */
     original?: string;
     /**
-     * Translated membership name. Defaults to `original` when not provided.
+     * Membership name translated into the buyer's language.
+     *
+     * Default: The value of `original`
      * @maxLength 100
      */
     translated?: string | null;
 }
 interface MembershipPaymentCredits {
     /**
-     * Membership's initial value.
+     * Membership's initial balance.
      * @min 1
      */
     total?: number;
-    /** Membership's remaining value. */
+    /** Membership's remaining balance. */
     remaining?: number;
 }
 declare enum BalanceType {
-    /** Balance is measured in discrete uses (e.g., sessions, visits). */
+    /** Balance is measured in discrete uses, such as sessions or visits. */
     PUNCH_CARD = "PUNCH_CARD",
-    /** Balance is measured in a currency-like value (e.g., points). */
+    /** Balance is measured in a currency-like value, such as points. */
     CREDIT = "CREDIT"
 }
 /** @enumType */
@@ -2444,25 +2446,26 @@ interface InvalidMembership {
      */
     reason?: string;
 }
-/** Same shape as `ListExistingMembershipsResponse.memberships`. */
+/** The validated existing memberships. 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.
+     * The selected memberships, each paired with the line items it can pay for 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 the member owns, together with the given 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).
+ * A membership is a single benefit granted by a plan the member has already paid for, so its coverage
+ * is nested directly here. No `benefitId` link is needed, unlike a plan that grants several 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.
+     * Line items this membership can pay for, and the cost to redeem each.
      * @maxSize 300
      */
     coveredLineItems?: CoveredLineItem[];
@@ -2477,11 +2480,10 @@ interface V1Membership {
     /** Membership name. */
     name?: MembershipName;
     /**
-     * Deprecated. Use `ExistingMembership.covered_line_items` to see which line items this membership covers.
+     * Deprecated. Use `ExistingMembership.coveredLineItems` to see which line items this membership
+     * covers.
      *
-     * Populate this only in the legacy `ListEligibleMemberships` flow, which still requires it and rejects a
-     * membership that omits it. Leave it empty everywhere else - `ListMembershipsByIds` receives no line items
-     * at all, so there is nothing to report there.
+     * Populate this only in the legacy [List Eligible Memberships](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/memberships/memberships-service-plugin/list-eligible-memberships) flow, which still requires it and rejects a membership that omits it. Leave it empty everywhere else. [List Memberships By IDs](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/memberships/memberships-service-plugin/list-memberships-by-ids) receives no line items at all, so there's nothing to report there.
      * @maxSize 300
      * @minLength 1
      * @maxLength 100
@@ -2490,12 +2492,18 @@ interface V1Membership {
      * @targetRemovalDate 2026-08-30
      */
     lineItemIds?: string[];
-    /** Membership's payment credits (balance information). */
+    /**
+     * Membership's balance.
+     *
+     * Omit this field for an unlimited membership, which has no balance to draw down. Every
+     * `ExistingMembership.coveredLineItems.redemptionCost` is then `0`. Unlike a plan's benefit, a
+     * membership carries no explicit unlimited marker: the absence of a balance is the marker.
+     */
     credits?: MembershipPaymentCredits;
-    /** Membership expiration date. */
+    /** Date and time the membership expires. */
     expirationDate?: Date | null;
     /**
-     * Deprecated. Use `offering_description` for human-readable provider data.
+     * Deprecated. Use `offeringDescription` for human-readable data about the offering.
      * @deprecated
      * @replacedBy offering_description
      * @targetRemovalDate 2026-08-30
@@ -2505,18 +2513,21 @@ interface V1Membership {
 /** A line item a membership can pay for, and the cost to redeem it. */
 interface CoveredLineItem {
     /**
-     * The input line item this membership can cover.
+     * ID of the line item this membership can pay for. Matches the `id` of one of the given line items.
      * @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).
+     * Amount deducted from the membership's remaining balance (`credits.remaining`) when this line item
+     * is redeemed.
+     *
+     * Always `0` for an unlimited membership, which is expressed by omitting `credits` and decrements
+     * nothing.
      */
     redemptionCost?: number;
 }
-/** Same shape as `ListPurchasablePlansResponse`. */
+/** The validated purchasable plans. Same shape as `ListPurchasablePlansResponse`. */
 interface ValidatedPurchasablePlans {
     /**
      * The selected plans.
@@ -2524,68 +2535,109 @@ interface ValidatedPurchasablePlans {
      */
     purchasablePlans?: PurchasablePlan[];
     /**
-     * How the plans' benefits cover the line items, linked to a benefit by `benefit_id`.
+     * How the plans' benefits cover the line items, each entry naming its benefit by `benefitId`.
      * @maxSize 300
      */
     coverages?: LineItemCoverage[];
 }
 interface PurchasablePlan {
-    /** Catalog and item reference for the plan that can be purchased. */
+    /**
+     * Catalog and item reference identifying both the plan and the pricing variant.
+     *
+     * A purchasable plan has no ID of its own. The reference carries the plan in `catalogItemId` and
+     * the chosen pricing variant in `options`, so the same plan appears once per variant with a
+     * different reference each time. The plan ID alone repeats across entries; the full reference
+     * doesn't.
+     *
+     * When the plan needs nothing further from the buyer, the reference can be added to the cart as it
+     * stands. When it does, for example a plan carrying a form, a custom start date, or a buyer-chosen
+     * price, the reference has to be completed with that input first. See `infoCollectionUrl`.
+     */
     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).
+     * Benefits the plan grants once purchased.
+     *
+     * A plan can grant several, for example a bundle granting separate yoga and pilates credits. Each
+     * benefit becomes its own membership after purchase.
      * @minSize 1
      * @maxSize 50
      */
     benefits?: Benefit[];
     /**
-     * Human-readable offering summary for display (for example price and validity text). Provider-supplied.
+     * Human-readable summary of what the plan offers, for display. For example, `8 yoga classes and 4
+     * pilates classes, billed monthly`.
+     *
+     * Describe the offering here and the price in `priceDescription`.
      * @maxLength 500
      */
     offeringDescription?: string | null;
     /**
-     * URL the buyer is redirected to in order to collect additional info required to purchase this plan.
+     * URL of the page that collects the extra input this plan needs before it can be purchased.
+     *
+     * Return it only for a plan that needs more from the buyer, such as one carrying a form, a custom
+     * start date, or a buyer-chosen price. Omitting it means the plan needs nothing further, and the
+     * caller builds the cart itself.
+     *
+     * The buyer reaches this page before any cart exists, rather than from the checkout page, and
+     * there's no return trip. The page receives the caller's already-created items, then builds the
+     * cart and checkout from the plan plus those items. There's no return URL, no cart ID, no
+     * preserved selection, and no completion signal: the purchase reaches Wix through the ordinary
+     * checkout and order flow, and the membership through Membership Ready To Be Charged.
+     *
+     * The page covers a single plan. Items that plan covers can be mixed with directly-paid ones, but
+     * a selection spanning two plans isn't supported here.
      * @format WEB_URL
      */
     infoCollectionUrl?: string | null;
     /**
-     * Plan price.
+     * Plan price, in the plan's own configured currency.
+     *
+     * No currency accompanies the amount and none is converted, so prices from different plans aren't
+     * comparable and the currency reaches the buyer only through `priceDescription`. Name the currency
+     * there.
      * @decimalValue options { gte:0, maxScale:3 }
      */
     price?: string;
     /**
-     * Human-readable description of the plan price (for example "First month free, then $20/month").
+     * Human-readable summary of the plan price, for display. 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.
+     * Use `price` for the bare amount, which is what sorting and comparison rely on, and this field for
+     * pricing a buyer needs prose to understand.
      * @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`).
+ * A single redeemable benefit granted by a plan.
+ *
+ * A purchasable plan grants one or more benefits in `benefits`. Once the plan is paid for, each benefit
+ * becomes its own membership, charged by `membershipId`.
  */
 interface Benefit extends BenefitQuotaOneOf {
     limitedQuota?: LimitedQuota;
     /**
-     * Identifier for this benefit. On a `PurchasablePlan` it must be unique within the response so
-     * `coverages` (`LineItemCoverage.benefit_id`) can reference it unambiguously across the plan's benefits.
+     * Identifier for this benefit, unique within its plan.
+     *
+     * Not unique across the response. A plan is returned once per pricing variant, and every variant
+     * repeats that plan's benefit IDs. Two different plans can also share an ID when they grant the
+     * same benefit, and a coverage entry naming it is then true for both.
+     *
+     * Never give two different benefits the same ID. That's the one case a caller can't recover from,
+     * because a cost computed for one benefit would be applied to the other.
      * @minLength 1
      * @maxLength 200
      */
     benefitId?: string;
     /**
-     * Human-readable label for this benefit (for example, "Manicure" or "Pedicure" on multi-set punchcards).
+     * Human-readable label for this benefit. For example, `Manicure` or `Pedicure` on a multi-set
+     * punch card.
      * @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`).
-     */
+    /** Kind of quota this benefit grants. */
     quotaType?: QuotaTypeWithLiterals;
 }
 /** @oneof */
@@ -2593,9 +2645,9 @@ interface BenefitQuotaOneOf {
     limitedQuota?: LimitedQuota;
 }
 declare enum QuotaType {
-    /** The benefit grants a countable quota that is drawn down on redemption. */
+    /** The benefit grants a countable quota that's drawn down on redemption. */
     LIMITED = "LIMITED",
-    /** The benefit is unlimited (unbounded) and is never drawn down. */
+    /** The benefit is unlimited and is never drawn down. */
     UNLIMITED = "UNLIMITED"
 }
 /** @enumType */
@@ -2603,45 +2655,64 @@ type QuotaTypeWithLiterals = QuotaType | 'LIMITED' | 'UNLIMITED';
 /** A limited, countable redeemable amount. */
 interface LimitedQuota {
     /**
-     * The quota's initial value.
+     * Quota's initial value.
      * @min 1
      */
     total?: number;
-    /** The quota's remaining value. */
+    /** Quota's remaining value. */
     remaining?: number;
-    /** How the quota is measured. */
+    /**
+     * How the quota is measured.
+     *
+     * The same vocabulary as `MembershipPaymentCredits.balanceType` on the existing-membership side.
+     */
     limitedQuotaType?: LimitedQuotaTypeWithLiterals;
 }
 declare enum LimitedQuotaType {
-    /** Quota is measured in discrete uses (e.g., sessions, visits). */
+    /** Quota is measured in discrete uses, such as sessions or visits. */
     PUNCH_CARD = "PUNCH_CARD",
-    /** Quota is measured in a currency-like value (e.g., points). */
+    /** Quota is measured in a currency-like value, such as points. */
     CREDIT = "CREDIT"
 }
 /** @enumType */
 type LimitedQuotaTypeWithLiterals = LimitedQuotaType | 'PUNCH_CARD' | 'CREDIT';
 /**
- * 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.
+ * Maps one of a plan's benefits to a line item it can cover, and at what cost.
+ *
+ * One entry per benefit and line item pair, returned by [List Purchasable Plans](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/memberships/memberships-service-plugin/list-purchasable-plans) alongside `purchasablePlans`.
+ *
+ * An entry names a benefit and carries no plan identity, so match its `benefitId` against the
+ * `benefits` of the returned plans and apply it to every entry that grants that benefit. Entries for
+ * the same plan repeat it once per pricing variant, and two different plans sharing a benefit ID
+ * grant the same benefit, so the entry holds for each of them. A caller that stops at the first
+ * match shows nothing incorrect, but hides the other entries, which cover the item too.
+ *
+ * The cost is identical across a plan's variants, so there's one entry per benefit rather than one
+ * per variant.
+ *
+ * For memberships the member already owns, the equivalent mapping is
+ * `ExistingMembership.coveredLineItems`, which needs no `benefitId` because a membership is a single
+ * benefit.
  */
 interface LineItemCoverage {
     /**
-     * The benefit that covers the line item, as returned in `Benefit.benefit_id`.
+     * ID of the benefit that covers the line item, as returned in `Benefit.benefitId`.
+     *
+     * Identifies a benefit within its plan, and repeats across that plan's pricing variants.
      * @minLength 1
      * @maxLength 200
      */
     benefitId?: string;
     /**
-     * The line item this benefit covers.
+     * ID of the line item this benefit covers.
      * @minLength 1
      * @maxLength 100
      */
     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).
+     * Amount deducted from the benefit's `limitedQuota.remaining` value when this line item is redeemed.
+     *
+     * Always `0` for an unlimited benefit, which decrements nothing.
      */
     redemptionCost?: number;
 }