@wix/auto_sdk_ecom_cart 1.0.181 → 1.0.183
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +1 -1
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +150 -58
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +150 -58
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +1 -1
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +150 -58
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +150 -58
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +1 -1
- package/build/internal/cjs/index.typings.d.ts +167 -62
- package/build/internal/cjs/meta.d.ts +167 -62
- package/build/internal/es/index.d.mts +1 -1
- package/build/internal/es/index.typings.d.mts +167 -62
- package/build/internal/es/meta.d.mts +167 -62
- package/package.json +2 -2
|
@@ -597,7 +597,7 @@ interface SubscriptionSettings {
|
|
|
597
597
|
* @min 1
|
|
598
598
|
*/
|
|
599
599
|
billingCycles?: number | null;
|
|
600
|
-
/** Whether to allow the customer to cancel the subscription
|
|
600
|
+
/** Whether to allow the customer to cancel the subscription. */
|
|
601
601
|
enableCustomerCancellation?: boolean;
|
|
602
602
|
/**
|
|
603
603
|
* Period until first cycle starts. If applied payNow will be 0
|
|
@@ -641,6 +641,27 @@ declare enum ProductPeriodAlignment {
|
|
|
641
641
|
}
|
|
642
642
|
/** @enumType */
|
|
643
643
|
type ProductPeriodAlignmentWithLiterals = ProductPeriodAlignment | 'ALIGNED_WITH_BILLING_PERIOD' | 'NOT_ALIGNED_WITH_BILLING_PERIOD';
|
|
644
|
+
interface CyclePriceOverride {
|
|
645
|
+
/**
|
|
646
|
+
* __Required.__ First billing cycle the price applies to. The first paid cycle of the
|
|
647
|
+
* subscription is `1`. A free trial period, if any, is cycle `0`.
|
|
648
|
+
* @min 1
|
|
649
|
+
* @max 1
|
|
650
|
+
*/
|
|
651
|
+
cycleFrom?: number;
|
|
652
|
+
/**
|
|
653
|
+
* __Required.__ Number of consecutive billing cycles the price applies to, starting at `cycleFrom`.
|
|
654
|
+
* @min 1
|
|
655
|
+
* @max 1
|
|
656
|
+
*/
|
|
657
|
+
numberOfCycles?: number | null;
|
|
658
|
+
/**
|
|
659
|
+
* __Required.__ Unit price for the cycles this entry covers, in the item's currency.
|
|
660
|
+
* Can be higher than, lower than, or equal to the item's `price`.
|
|
661
|
+
* @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
|
|
662
|
+
*/
|
|
663
|
+
price?: string;
|
|
664
|
+
}
|
|
644
665
|
interface Title {
|
|
645
666
|
/**
|
|
646
667
|
* Subscription option name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
@@ -2407,29 +2428,31 @@ interface Membership {
|
|
|
2407
2428
|
}
|
|
2408
2429
|
interface MembershipName {
|
|
2409
2430
|
/**
|
|
2410
|
-
* Membership name.
|
|
2431
|
+
* Membership name in the site's original language.
|
|
2411
2432
|
* @maxLength 100
|
|
2412
2433
|
*/
|
|
2413
2434
|
original?: string;
|
|
2414
2435
|
/**
|
|
2415
|
-
*
|
|
2436
|
+
* Membership name translated into the buyer's language.
|
|
2437
|
+
*
|
|
2438
|
+
* Default: The value of `original`
|
|
2416
2439
|
* @maxLength 100
|
|
2417
2440
|
*/
|
|
2418
2441
|
translated?: string | null;
|
|
2419
2442
|
}
|
|
2420
2443
|
interface MembershipPaymentCredits {
|
|
2421
2444
|
/**
|
|
2422
|
-
* Membership's initial
|
|
2445
|
+
* Membership's initial balance.
|
|
2423
2446
|
* @min 1
|
|
2424
2447
|
*/
|
|
2425
2448
|
total?: number;
|
|
2426
|
-
/** Membership's remaining
|
|
2449
|
+
/** Membership's remaining balance. */
|
|
2427
2450
|
remaining?: number;
|
|
2428
2451
|
}
|
|
2429
2452
|
declare enum BalanceType {
|
|
2430
|
-
/** Balance is measured in discrete uses
|
|
2453
|
+
/** Balance is measured in discrete uses, such as sessions or visits. */
|
|
2431
2454
|
PUNCH_CARD = "PUNCH_CARD",
|
|
2432
|
-
/** Balance is measured in a currency-like value
|
|
2455
|
+
/** Balance is measured in a currency-like value, such as points. */
|
|
2433
2456
|
CREDIT = "CREDIT"
|
|
2434
2457
|
}
|
|
2435
2458
|
/** @enumType */
|
|
@@ -2444,25 +2467,26 @@ interface InvalidMembership {
|
|
|
2444
2467
|
*/
|
|
2445
2468
|
reason?: string;
|
|
2446
2469
|
}
|
|
2447
|
-
/** Same shape as `ListExistingMembershipsResponse.memberships`. */
|
|
2470
|
+
/** The validated existing memberships. Same shape as `ListExistingMembershipsResponse.memberships`. */
|
|
2448
2471
|
interface ValidatedExistingMemberships {
|
|
2449
2472
|
/**
|
|
2450
|
-
* The selected memberships, each paired with the line items it can
|
|
2473
|
+
* The selected memberships, each paired with the line items it can pay for and the cost to redeem
|
|
2474
|
+
* each.
|
|
2451
2475
|
* @maxSize 300
|
|
2452
2476
|
*/
|
|
2453
2477
|
memberships?: ExistingMembership[];
|
|
2454
2478
|
}
|
|
2455
2479
|
/**
|
|
2456
|
-
* A membership the member
|
|
2480
|
+
* A membership the member owns, together with the given line items it can pay for.
|
|
2457
2481
|
*
|
|
2458
|
-
* A membership is a single benefit granted by a plan the member has already paid for, so coverage
|
|
2459
|
-
* nested here
|
|
2482
|
+
* A membership is a single benefit granted by a plan the member has already paid for, so its coverage
|
|
2483
|
+
* is nested directly here. No `benefitId` link is needed, unlike a plan that grants several benefits.
|
|
2460
2484
|
*/
|
|
2461
2485
|
interface ExistingMembership {
|
|
2462
2486
|
/** The membership the member owns. */
|
|
2463
2487
|
membership?: V1Membership;
|
|
2464
2488
|
/**
|
|
2465
|
-
*
|
|
2489
|
+
* Line items this membership can pay for, and the cost to redeem each.
|
|
2466
2490
|
* @maxSize 300
|
|
2467
2491
|
*/
|
|
2468
2492
|
coveredLineItems?: CoveredLineItem[];
|
|
@@ -2477,11 +2501,10 @@ interface V1Membership {
|
|
|
2477
2501
|
/** Membership name. */
|
|
2478
2502
|
name?: MembershipName;
|
|
2479
2503
|
/**
|
|
2480
|
-
* Deprecated. Use `ExistingMembership.
|
|
2504
|
+
* Deprecated. Use `ExistingMembership.coveredLineItems` to see which line items this membership
|
|
2505
|
+
* covers.
|
|
2481
2506
|
*
|
|
2482
|
-
* Populate this only in the legacy
|
|
2483
|
-
* membership that omits it. Leave it empty everywhere else - `ListMembershipsByIds` receives no line items
|
|
2484
|
-
* at all, so there is nothing to report there.
|
|
2507
|
+
* 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.
|
|
2485
2508
|
* @maxSize 300
|
|
2486
2509
|
* @minLength 1
|
|
2487
2510
|
* @maxLength 100
|
|
@@ -2490,12 +2513,18 @@ interface V1Membership {
|
|
|
2490
2513
|
* @targetRemovalDate 2026-08-30
|
|
2491
2514
|
*/
|
|
2492
2515
|
lineItemIds?: string[];
|
|
2493
|
-
/**
|
|
2516
|
+
/**
|
|
2517
|
+
* Membership's balance.
|
|
2518
|
+
*
|
|
2519
|
+
* Omit this field for an unlimited membership, which has no balance to draw down. Every
|
|
2520
|
+
* `ExistingMembership.coveredLineItems.redemptionCost` is then `0`. Unlike a plan's benefit, a
|
|
2521
|
+
* membership carries no explicit unlimited marker: the absence of a balance is the marker.
|
|
2522
|
+
*/
|
|
2494
2523
|
credits?: MembershipPaymentCredits;
|
|
2495
|
-
/**
|
|
2524
|
+
/** Date and time the membership expires. */
|
|
2496
2525
|
expirationDate?: Date | null;
|
|
2497
2526
|
/**
|
|
2498
|
-
* Deprecated. Use `
|
|
2527
|
+
* Deprecated. Use `offeringDescription` for human-readable data about the offering.
|
|
2499
2528
|
* @deprecated
|
|
2500
2529
|
* @replacedBy offering_description
|
|
2501
2530
|
* @targetRemovalDate 2026-08-30
|
|
@@ -2505,18 +2534,21 @@ interface V1Membership {
|
|
|
2505
2534
|
/** A line item a membership can pay for, and the cost to redeem it. */
|
|
2506
2535
|
interface CoveredLineItem {
|
|
2507
2536
|
/**
|
|
2508
|
-
*
|
|
2537
|
+
* ID of the line item this membership can pay for. Matches the `id` of one of the given line items.
|
|
2509
2538
|
* @minLength 1
|
|
2510
2539
|
* @maxLength 100
|
|
2511
2540
|
*/
|
|
2512
2541
|
lineItemId?: string;
|
|
2513
2542
|
/**
|
|
2514
|
-
*
|
|
2515
|
-
*
|
|
2543
|
+
* Amount deducted from the membership's remaining balance (`credits.remaining`) when this line item
|
|
2544
|
+
* is redeemed.
|
|
2545
|
+
*
|
|
2546
|
+
* Always `0` for an unlimited membership, which is expressed by omitting `credits` and decrements
|
|
2547
|
+
* nothing.
|
|
2516
2548
|
*/
|
|
2517
2549
|
redemptionCost?: number;
|
|
2518
2550
|
}
|
|
2519
|
-
/** Same shape as `ListPurchasablePlansResponse`. */
|
|
2551
|
+
/** The validated purchasable plans. Same shape as `ListPurchasablePlansResponse`. */
|
|
2520
2552
|
interface ValidatedPurchasablePlans {
|
|
2521
2553
|
/**
|
|
2522
2554
|
* The selected plans.
|
|
@@ -2524,68 +2556,109 @@ interface ValidatedPurchasablePlans {
|
|
|
2524
2556
|
*/
|
|
2525
2557
|
purchasablePlans?: PurchasablePlan[];
|
|
2526
2558
|
/**
|
|
2527
|
-
* How the plans' benefits cover the line items,
|
|
2559
|
+
* How the plans' benefits cover the line items, each entry naming its benefit by `benefitId`.
|
|
2528
2560
|
* @maxSize 300
|
|
2529
2561
|
*/
|
|
2530
2562
|
coverages?: LineItemCoverage[];
|
|
2531
2563
|
}
|
|
2532
2564
|
interface PurchasablePlan {
|
|
2533
|
-
/**
|
|
2565
|
+
/**
|
|
2566
|
+
* Catalog and item reference identifying both the plan and the pricing variant.
|
|
2567
|
+
*
|
|
2568
|
+
* A purchasable plan has no ID of its own. The reference carries the plan in `catalogItemId` and
|
|
2569
|
+
* the chosen pricing variant in `options`, so the same plan appears once per variant with a
|
|
2570
|
+
* different reference each time. The plan ID alone repeats across entries; the full reference
|
|
2571
|
+
* doesn't.
|
|
2572
|
+
*
|
|
2573
|
+
* When the plan needs nothing further from the buyer, the reference can be added to the cart as it
|
|
2574
|
+
* stands. When it does, for example a plan carrying a form, a custom start date, or a buyer-chosen
|
|
2575
|
+
* price, the reference has to be completed with that input first. See `infoCollectionUrl`.
|
|
2576
|
+
*/
|
|
2534
2577
|
catalogReference?: CatalogReference;
|
|
2535
2578
|
/** Plan name. */
|
|
2536
2579
|
name?: MembershipName;
|
|
2537
2580
|
/**
|
|
2538
|
-
* Benefits the plan
|
|
2581
|
+
* Benefits the plan grants once purchased.
|
|
2582
|
+
*
|
|
2583
|
+
* A plan can grant several, for example a bundle granting separate yoga and pilates credits. Each
|
|
2584
|
+
* benefit becomes its own membership after purchase.
|
|
2539
2585
|
* @minSize 1
|
|
2540
2586
|
* @maxSize 50
|
|
2541
2587
|
*/
|
|
2542
2588
|
benefits?: Benefit[];
|
|
2543
2589
|
/**
|
|
2544
|
-
* Human-readable
|
|
2590
|
+
* Human-readable summary of what the plan offers, for display. For example, `8 yoga classes and 4
|
|
2591
|
+
* pilates classes, billed monthly`.
|
|
2592
|
+
*
|
|
2593
|
+
* Describe the offering here and the price in `priceDescription`.
|
|
2545
2594
|
* @maxLength 500
|
|
2546
2595
|
*/
|
|
2547
2596
|
offeringDescription?: string | null;
|
|
2548
2597
|
/**
|
|
2549
|
-
* URL the
|
|
2598
|
+
* URL of the page that collects the extra input this plan needs before it can be purchased.
|
|
2599
|
+
*
|
|
2600
|
+
* Return it only for a plan that needs more from the buyer, such as one carrying a form, a custom
|
|
2601
|
+
* start date, or a buyer-chosen price. Omitting it means the plan needs nothing further, and the
|
|
2602
|
+
* caller builds the cart itself.
|
|
2603
|
+
*
|
|
2604
|
+
* The buyer reaches this page before any cart exists, rather than from the checkout page, and
|
|
2605
|
+
* there's no return trip. The page receives the caller's already-created items, then builds the
|
|
2606
|
+
* cart and checkout from the plan plus those items. There's no return URL, no cart ID, no
|
|
2607
|
+
* preserved selection, and no completion signal: the purchase reaches Wix through the ordinary
|
|
2608
|
+
* checkout and order flow, and the membership through Membership Ready To Be Charged.
|
|
2609
|
+
*
|
|
2610
|
+
* The page covers a single plan. Items that plan covers can be mixed with directly-paid ones, but
|
|
2611
|
+
* a selection spanning two plans isn't supported here.
|
|
2550
2612
|
* @format WEB_URL
|
|
2551
2613
|
*/
|
|
2552
2614
|
infoCollectionUrl?: string | null;
|
|
2553
2615
|
/**
|
|
2554
|
-
* Plan price.
|
|
2616
|
+
* Plan price, in the plan's own configured currency.
|
|
2617
|
+
*
|
|
2618
|
+
* No currency accompanies the amount and none is converted, so prices from different plans aren't
|
|
2619
|
+
* comparable and the currency reaches the buyer only through `priceDescription`. Name the currency
|
|
2620
|
+
* there.
|
|
2555
2621
|
* @decimalValue options { gte:0, maxScale:3 }
|
|
2556
2622
|
*/
|
|
2557
2623
|
price?: string;
|
|
2558
2624
|
/**
|
|
2559
|
-
* Human-readable
|
|
2625
|
+
* Human-readable summary of the plan price, for display. For example, `First month free, then
|
|
2626
|
+
* $20/month`.
|
|
2560
2627
|
*
|
|
2561
|
-
* `price`
|
|
2562
|
-
*
|
|
2628
|
+
* Use `price` for the bare amount, which is what sorting and comparison rely on, and this field for
|
|
2629
|
+
* pricing a buyer needs prose to understand.
|
|
2563
2630
|
* @maxLength 500
|
|
2564
2631
|
*/
|
|
2565
2632
|
priceDescription?: string | null;
|
|
2566
2633
|
}
|
|
2567
2634
|
/**
|
|
2568
|
-
* A single redeemable benefit
|
|
2569
|
-
*
|
|
2635
|
+
* A single redeemable benefit granted by a plan.
|
|
2636
|
+
*
|
|
2637
|
+
* A purchasable plan grants one or more benefits in `benefits`. Once the plan is paid for, each benefit
|
|
2638
|
+
* becomes its own membership, charged by `membershipId`.
|
|
2570
2639
|
*/
|
|
2571
2640
|
interface Benefit extends BenefitQuotaOneOf {
|
|
2572
2641
|
limitedQuota?: LimitedQuota;
|
|
2573
2642
|
/**
|
|
2574
|
-
* Identifier for this benefit
|
|
2575
|
-
*
|
|
2643
|
+
* Identifier for this benefit, unique within its plan.
|
|
2644
|
+
*
|
|
2645
|
+
* Not unique across the response. A plan is returned once per pricing variant, and every variant
|
|
2646
|
+
* repeats that plan's benefit IDs. Two different plans can also share an ID when they grant the
|
|
2647
|
+
* same benefit, and a coverage entry naming it is then true for both.
|
|
2648
|
+
*
|
|
2649
|
+
* Never give two different benefits the same ID. That's the one case a caller can't recover from,
|
|
2650
|
+
* because a cost computed for one benefit would be applied to the other.
|
|
2576
2651
|
* @minLength 1
|
|
2577
2652
|
* @maxLength 200
|
|
2578
2653
|
*/
|
|
2579
2654
|
benefitId?: string;
|
|
2580
2655
|
/**
|
|
2581
|
-
* Human-readable label for this benefit
|
|
2656
|
+
* Human-readable label for this benefit. For example, `Manicure` or `Pedicure` on a multi-set
|
|
2657
|
+
* punch card.
|
|
2582
2658
|
* @maxLength 200
|
|
2583
2659
|
*/
|
|
2584
2660
|
label?: string | null;
|
|
2585
|
-
/**
|
|
2586
|
-
* The kind of quota this benefit grants: a countable amount drawn down on redemption (`LIMITED`),
|
|
2587
|
-
* or an unbounded amount that is never drawn down (`UNLIMITED`).
|
|
2588
|
-
*/
|
|
2661
|
+
/** Kind of quota this benefit grants. */
|
|
2589
2662
|
quotaType?: QuotaTypeWithLiterals;
|
|
2590
2663
|
}
|
|
2591
2664
|
/** @oneof */
|
|
@@ -2593,9 +2666,9 @@ interface BenefitQuotaOneOf {
|
|
|
2593
2666
|
limitedQuota?: LimitedQuota;
|
|
2594
2667
|
}
|
|
2595
2668
|
declare enum QuotaType {
|
|
2596
|
-
/** The benefit grants a countable quota that
|
|
2669
|
+
/** The benefit grants a countable quota that's drawn down on redemption. */
|
|
2597
2670
|
LIMITED = "LIMITED",
|
|
2598
|
-
/** The benefit is unlimited
|
|
2671
|
+
/** The benefit is unlimited and is never drawn down. */
|
|
2599
2672
|
UNLIMITED = "UNLIMITED"
|
|
2600
2673
|
}
|
|
2601
2674
|
/** @enumType */
|
|
@@ -2603,45 +2676,64 @@ type QuotaTypeWithLiterals = QuotaType | 'LIMITED' | 'UNLIMITED';
|
|
|
2603
2676
|
/** A limited, countable redeemable amount. */
|
|
2604
2677
|
interface LimitedQuota {
|
|
2605
2678
|
/**
|
|
2606
|
-
*
|
|
2679
|
+
* Quota's initial value.
|
|
2607
2680
|
* @min 1
|
|
2608
2681
|
*/
|
|
2609
2682
|
total?: number;
|
|
2610
|
-
/**
|
|
2683
|
+
/** Quota's remaining value. */
|
|
2611
2684
|
remaining?: number;
|
|
2612
|
-
/**
|
|
2685
|
+
/**
|
|
2686
|
+
* How the quota is measured.
|
|
2687
|
+
*
|
|
2688
|
+
* The same vocabulary as `MembershipPaymentCredits.balanceType` on the existing-membership side.
|
|
2689
|
+
*/
|
|
2613
2690
|
limitedQuotaType?: LimitedQuotaTypeWithLiterals;
|
|
2614
2691
|
}
|
|
2615
2692
|
declare enum LimitedQuotaType {
|
|
2616
|
-
/** Quota is measured in discrete uses
|
|
2693
|
+
/** Quota is measured in discrete uses, such as sessions or visits. */
|
|
2617
2694
|
PUNCH_CARD = "PUNCH_CARD",
|
|
2618
|
-
/** Quota is measured in a currency-like value
|
|
2695
|
+
/** Quota is measured in a currency-like value, such as points. */
|
|
2619
2696
|
CREDIT = "CREDIT"
|
|
2620
2697
|
}
|
|
2621
2698
|
/** @enumType */
|
|
2622
2699
|
type LimitedQuotaTypeWithLiterals = LimitedQuotaType | 'PUNCH_CARD' | 'CREDIT';
|
|
2623
2700
|
/**
|
|
2624
|
-
* Maps a
|
|
2625
|
-
*
|
|
2626
|
-
*
|
|
2627
|
-
*
|
|
2701
|
+
* Maps one of a plan's benefits to a line item it can cover, and at what cost.
|
|
2702
|
+
*
|
|
2703
|
+
* 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`.
|
|
2704
|
+
*
|
|
2705
|
+
* An entry names a benefit and carries no plan identity, so match its `benefitId` against the
|
|
2706
|
+
* `benefits` of the returned plans and apply it to every entry that grants that benefit. Entries for
|
|
2707
|
+
* the same plan repeat it once per pricing variant, and two different plans sharing a benefit ID
|
|
2708
|
+
* grant the same benefit, so the entry holds for each of them. A caller that stops at the first
|
|
2709
|
+
* match shows nothing incorrect, but hides the other entries, which cover the item too.
|
|
2710
|
+
*
|
|
2711
|
+
* The cost is identical across a plan's variants, so there's one entry per benefit rather than one
|
|
2712
|
+
* per variant.
|
|
2713
|
+
*
|
|
2714
|
+
* For memberships the member already owns, the equivalent mapping is
|
|
2715
|
+
* `ExistingMembership.coveredLineItems`, which needs no `benefitId` because a membership is a single
|
|
2716
|
+
* benefit.
|
|
2628
2717
|
*/
|
|
2629
2718
|
interface LineItemCoverage {
|
|
2630
2719
|
/**
|
|
2631
|
-
*
|
|
2720
|
+
* ID of the benefit that covers the line item, as returned in `Benefit.benefitId`.
|
|
2721
|
+
*
|
|
2722
|
+
* Identifies a benefit within its plan, and repeats across that plan's pricing variants.
|
|
2632
2723
|
* @minLength 1
|
|
2633
2724
|
* @maxLength 200
|
|
2634
2725
|
*/
|
|
2635
2726
|
benefitId?: string;
|
|
2636
2727
|
/**
|
|
2637
|
-
*
|
|
2728
|
+
* ID of the line item this benefit covers.
|
|
2638
2729
|
* @minLength 1
|
|
2639
2730
|
* @maxLength 100
|
|
2640
2731
|
*/
|
|
2641
2732
|
lineItemId?: string;
|
|
2642
2733
|
/**
|
|
2643
|
-
*
|
|
2644
|
-
*
|
|
2734
|
+
* Amount deducted from the benefit's `limitedQuota.remaining` value when this line item is redeemed.
|
|
2735
|
+
*
|
|
2736
|
+
* Always `0` for an unlimited benefit, which decrements nothing.
|
|
2645
2737
|
*/
|
|
2646
2738
|
redemptionCost?: number;
|
|
2647
2739
|
}
|
|
@@ -3877,4 +3969,4 @@ declare function deleteCart(_id: string): Promise<void>;
|
|
|
3877
3969
|
*/
|
|
3878
3970
|
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`, 5>>;
|
|
3879
3971
|
|
|
3880
|
-
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 CoveredLineItem, 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 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 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 UpdateCartApplicationErrors, type UpdateCartOptions, type UpdateCartRequest, type UpdateCartResponse, type UpdateCurrentCartLineItemQuantityRequest, 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, addToCart, createCart, createCheckout, deleteCart, estimateTotals, getCart, onCartCreated, onCartDeleted, onCartUpdated, removeBusinessLocation, removeCoupon, removeLineItems, updateCart, updateLineItemsQuantity };
|
|
3972
|
+
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 CoveredLineItem, type CreateCartApplicationErrors, type CreateCartOptions, type CreateCartRequest, type CreateCartResponse, type CreateCheckoutApplicationErrors, type CreateCheckoutFromCurrentCartRequest, type CreateCheckoutOptions, type CreateCheckoutRequest, type CreateCheckoutResponse, type CustomLineItem, type CyclePriceOverride, 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 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 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 UpdateCartApplicationErrors, type UpdateCartOptions, type UpdateCartRequest, type UpdateCartResponse, type UpdateCurrentCartLineItemQuantityRequest, 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, addToCart, createCart, createCheckout, deleteCart, estimateTotals, getCart, onCartCreated, onCartDeleted, onCartUpdated, removeBusinessLocation, removeCoupon, removeLineItems, updateCart, updateLineItemsQuantity };
|