@wix/auto_sdk_pricing-plans_orders 1.0.67 → 1.0.69
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 +11 -26
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +9 -25
- package/build/cjs/index.typings.js.map +1 -1
- package/build/es/index.d.mts +11 -26
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +9 -25
- package/build/es/index.typings.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +11 -26
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +9 -25
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/es/index.d.mts +11 -26
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +9 -25
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/package.json +3 -3
|
@@ -2114,7 +2114,6 @@ interface OrderStartDateChangedEnvelope {
|
|
|
2114
2114
|
* @slug start_date_changed
|
|
2115
2115
|
*/
|
|
2116
2116
|
declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
|
|
2117
|
-
type OrderNonNullablePaths = `_id` | `planId` | `subscriptionId` | `buyer.memberId` | `buyer.contactId` | `priceDetails.subscription.cycleDuration.unit` | `priceDetails.subtotal` | `priceDetails.discount` | `priceDetails.tax.name` | `priceDetails.tax.includedInPrice` | `priceDetails.tax.rate` | `priceDetails.tax.amount` | `priceDetails.total` | `priceDetails.planPrice` | `priceDetails.currency` | `priceDetails.coupon.code` | `priceDetails.coupon.amount` | `priceDetails.coupon._id` | `pricing.subscription.cycleDuration.unit` | `pricing.prices` | `pricing.prices.${number}.duration.cycleFrom` | `pricing.prices.${number}.price.subtotal` | `pricing.prices.${number}.price.coupon.code` | `pricing.prices.${number}.price.coupon.amount` | `pricing.prices.${number}.price.coupon._id` | `pricing.prices.${number}.price.discount` | `pricing.prices.${number}.price.tax.name` | `pricing.prices.${number}.price.tax.includedInPrice` | `pricing.prices.${number}.price.tax.rate` | `pricing.prices.${number}.price.tax.amount` | `pricing.prices.${number}.price.total` | `pricing.prices.${number}.price.currency` | `pricing.prices.${number}.price.proration` | `type` | `status` | `cancellation.cause` | `cancellation.effectiveAt` | `lastPaymentStatus` | `pausePeriods` | `pausePeriods.${number}.status` | `currentCycle.index` | `planName` | `planDescription` | `planPrice`;
|
|
2118
2117
|
/**
|
|
2119
2118
|
* Retrieves an order by ID.
|
|
2120
2119
|
* @param _id - Order ID.
|
|
@@ -2125,9 +2124,7 @@ type OrderNonNullablePaths = `_id` | `planId` | `subscriptionId` | `buyer.member
|
|
|
2125
2124
|
* @applicableIdentity APP
|
|
2126
2125
|
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
|
|
2127
2126
|
*/
|
|
2128
|
-
declare function managementGetOrder(_id: string, options?: ManagementGetOrderOptions): Promise<NonNullablePaths<GetOrderResponse, {
|
|
2129
|
-
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
2130
|
-
}[OrderNonNullablePaths]>>;
|
|
2127
|
+
declare function managementGetOrder(_id: string, options?: ManagementGetOrderOptions): Promise<NonNullablePaths<GetOrderResponse, `order._id` | `order.planId` | `order.subscriptionId` | `order.buyer.memberId` | `order.buyer.contactId` | `order.priceDetails.subscription.cycleDuration.unit` | `order.priceDetails.subtotal` | `order.priceDetails.discount` | `order.priceDetails.tax.name` | `order.priceDetails.tax.includedInPrice` | `order.priceDetails.tax.rate` | `order.priceDetails.tax.amount` | `order.priceDetails.total` | `order.priceDetails.planPrice` | `order.priceDetails.currency` | `order.priceDetails.coupon.code` | `order.priceDetails.coupon.amount` | `order.priceDetails.coupon._id` | `order.pricing.prices` | `order.pricing.prices.${number}.duration.cycleFrom` | `order.pricing.prices.${number}.price.subtotal` | `order.pricing.prices.${number}.price.discount` | `order.pricing.prices.${number}.price.total` | `order.pricing.prices.${number}.price.currency` | `order.pricing.prices.${number}.price.proration` | `order.type` | `order.status` | `order.cancellation.cause` | `order.cancellation.effectiveAt` | `order.lastPaymentStatus` | `order.pausePeriods` | `order.pausePeriods.${number}.status` | `order.currentCycle.index` | `order.planName` | `order.planDescription` | `order.planPrice`, 7>>;
|
|
2131
2128
|
interface ManagementGetOrderOptions {
|
|
2132
2129
|
/**
|
|
2133
2130
|
* Predefined set of fields to return.
|
|
@@ -2147,9 +2144,7 @@ interface ManagementGetOrderOptions {
|
|
|
2147
2144
|
* @applicableIdentity APP
|
|
2148
2145
|
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
|
|
2149
2146
|
*/
|
|
2150
|
-
declare function managementListOrders(options?: ManagementListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, {
|
|
2151
|
-
[P in OrderNonNullablePaths]: `orders.${number}.${P}`;
|
|
2152
|
-
}[OrderNonNullablePaths]>>;
|
|
2147
|
+
declare function managementListOrders(options?: ManagementListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, `orders` | `orders.${number}._id` | `orders.${number}.planId` | `orders.${number}.subscriptionId` | `orders.${number}.buyer.memberId` | `orders.${number}.buyer.contactId` | `orders.${number}.priceDetails.singlePaymentForDuration.unit` | `orders.${number}.priceDetails.subtotal` | `orders.${number}.priceDetails.discount` | `orders.${number}.priceDetails.tax.name` | `orders.${number}.priceDetails.tax.includedInPrice` | `orders.${number}.priceDetails.tax.rate` | `orders.${number}.priceDetails.tax.amount` | `orders.${number}.priceDetails.total` | `orders.${number}.priceDetails.planPrice` | `orders.${number}.priceDetails.currency` | `orders.${number}.priceDetails.coupon.code` | `orders.${number}.priceDetails.coupon.amount` | `orders.${number}.priceDetails.coupon._id` | `orders.${number}.type` | `orders.${number}.status` | `orders.${number}.cancellation.cause` | `orders.${number}.cancellation.effectiveAt` | `orders.${number}.lastPaymentStatus` | `orders.${number}.currentCycle.index` | `orders.${number}.planName` | `orders.${number}.planDescription` | `orders.${number}.planPrice`, 6>>;
|
|
2153
2148
|
interface ManagementListOrdersOptions {
|
|
2154
2149
|
/**
|
|
2155
2150
|
* Filter by a buyer's member ID, from the Members API.
|
|
@@ -2305,7 +2300,7 @@ declare function resumeOrder(_id: string): Promise<void>;
|
|
|
2305
2300
|
* @returns Requested order.
|
|
2306
2301
|
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder
|
|
2307
2302
|
*/
|
|
2308
|
-
declare function memberGetOrder(_id: string, options?: MemberGetOrderOptions): Promise<NonNullablePaths<Order,
|
|
2303
|
+
declare function memberGetOrder(_id: string, options?: MemberGetOrderOptions): Promise<NonNullablePaths<Order, `_id` | `planId` | `subscriptionId` | `buyer.memberId` | `buyer.contactId` | `priceDetails.subscription.cycleDuration.unit` | `priceDetails.subtotal` | `priceDetails.discount` | `priceDetails.tax.name` | `priceDetails.tax.includedInPrice` | `priceDetails.tax.rate` | `priceDetails.tax.amount` | `priceDetails.total` | `priceDetails.planPrice` | `priceDetails.currency` | `priceDetails.coupon.code` | `priceDetails.coupon.amount` | `priceDetails.coupon._id` | `pricing.prices` | `pricing.prices.${number}.duration.cycleFrom` | `pricing.prices.${number}.price.subtotal` | `pricing.prices.${number}.price.discount` | `pricing.prices.${number}.price.total` | `pricing.prices.${number}.price.currency` | `pricing.prices.${number}.price.proration` | `type` | `status` | `cancellation.cause` | `cancellation.effectiveAt` | `lastPaymentStatus` | `pausePeriods` | `pausePeriods.${number}.status` | `currentCycle.index` | `planName` | `planDescription` | `planPrice`, 6>>;
|
|
2309
2304
|
interface MemberGetOrderOptions {
|
|
2310
2305
|
/**
|
|
2311
2306
|
* Predefined set of fields to return.
|
|
@@ -2323,9 +2318,7 @@ interface MemberGetOrderOptions {
|
|
|
2323
2318
|
* @applicableIdentity MEMBER
|
|
2324
2319
|
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.ListOrders
|
|
2325
2320
|
*/
|
|
2326
|
-
declare function memberListOrders(options?: MemberListOrdersOptions): Promise<NonNullablePaths<MemberListOrdersResponse, {
|
|
2327
|
-
[P in OrderNonNullablePaths]: `orders.${number}.${P}`;
|
|
2328
|
-
}[OrderNonNullablePaths]>>;
|
|
2321
|
+
declare function memberListOrders(options?: MemberListOrdersOptions): Promise<NonNullablePaths<MemberListOrdersResponse, `orders` | `orders.${number}._id` | `orders.${number}.planId` | `orders.${number}.subscriptionId` | `orders.${number}.buyer.memberId` | `orders.${number}.buyer.contactId` | `orders.${number}.priceDetails.singlePaymentForDuration.unit` | `orders.${number}.priceDetails.subtotal` | `orders.${number}.priceDetails.discount` | `orders.${number}.priceDetails.tax.name` | `orders.${number}.priceDetails.tax.includedInPrice` | `orders.${number}.priceDetails.tax.rate` | `orders.${number}.priceDetails.tax.amount` | `orders.${number}.priceDetails.total` | `orders.${number}.priceDetails.planPrice` | `orders.${number}.priceDetails.currency` | `orders.${number}.priceDetails.coupon.code` | `orders.${number}.priceDetails.coupon.amount` | `orders.${number}.priceDetails.coupon._id` | `orders.${number}.type` | `orders.${number}.status` | `orders.${number}.cancellation.cause` | `orders.${number}.cancellation.effectiveAt` | `orders.${number}.lastPaymentStatus` | `orders.${number}.currentCycle.index` | `orders.${number}.planName` | `orders.${number}.planDescription` | `orders.${number}.planPrice`, 6>>;
|
|
2329
2322
|
interface MemberListOrdersOptions {
|
|
2330
2323
|
/**
|
|
2331
2324
|
* Filter by plan IDs.
|
|
@@ -2388,9 +2381,7 @@ declare function requestCancellation(_id: string, effectiveAt: CancellationEffec
|
|
|
2388
2381
|
* @requiredField planId
|
|
2389
2382
|
* @fqn com.wixpress.membership.v2.orders.CheckoutService.CreateOnlineOrder
|
|
2390
2383
|
*/
|
|
2391
|
-
declare function createOnlineOrder(planId: string, options?: NonNullablePaths<CreateOnlineOrderOptions, `onBehalf.memberId
|
|
2392
|
-
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
2393
|
-
}[OrderNonNullablePaths]> & {
|
|
2384
|
+
declare function createOnlineOrder(planId: string, options?: NonNullablePaths<CreateOnlineOrderOptions, `onBehalf.memberId`, 3>): Promise<NonNullablePaths<CreateOnlineOrderResponse, `order._id` | `order.planId` | `order.subscriptionId` | `order.buyer.memberId` | `order.buyer.contactId` | `order.priceDetails.subscription.cycleDuration.unit` | `order.priceDetails.subtotal` | `order.priceDetails.discount` | `order.priceDetails.tax.name` | `order.priceDetails.tax.includedInPrice` | `order.priceDetails.tax.rate` | `order.priceDetails.tax.amount` | `order.priceDetails.total` | `order.priceDetails.planPrice` | `order.priceDetails.currency` | `order.priceDetails.coupon.code` | `order.priceDetails.coupon.amount` | `order.priceDetails.coupon._id` | `order.pricing.prices` | `order.pricing.prices.${number}.duration.cycleFrom` | `order.pricing.prices.${number}.price.subtotal` | `order.pricing.prices.${number}.price.discount` | `order.pricing.prices.${number}.price.total` | `order.pricing.prices.${number}.price.currency` | `order.pricing.prices.${number}.price.proration` | `order.type` | `order.status` | `order.cancellation.cause` | `order.cancellation.effectiveAt` | `order.lastPaymentStatus` | `order.pausePeriods` | `order.pausePeriods.${number}.status` | `order.currentCycle.index` | `order.planName` | `order.planDescription` | `order.planPrice`, 7> & {
|
|
2394
2385
|
__applicationErrorsType?: CreateOnlineOrderApplicationErrors;
|
|
2395
2386
|
__validationErrorsType?: CreateOnlineOrderValidationErrors;
|
|
2396
2387
|
}>;
|
|
@@ -2443,9 +2434,7 @@ interface CreateOnlineOrderOptions {
|
|
|
2443
2434
|
* @applicableIdentity APP
|
|
2444
2435
|
* @fqn com.wixpress.membership.v2.orders.CheckoutService.CreateOfflineOrder
|
|
2445
2436
|
*/
|
|
2446
|
-
declare function createOfflineOrder(planId: string, memberId: string, options?: CreateOfflineOrderOptions): Promise<NonNullablePaths<CreateOfflineOrderResponse, {
|
|
2447
|
-
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
2448
|
-
}[OrderNonNullablePaths]> & {
|
|
2437
|
+
declare function createOfflineOrder(planId: string, memberId: string, options?: CreateOfflineOrderOptions): Promise<NonNullablePaths<CreateOfflineOrderResponse, `order._id` | `order.planId` | `order.subscriptionId` | `order.buyer.memberId` | `order.buyer.contactId` | `order.priceDetails.subscription.cycleDuration.unit` | `order.priceDetails.subtotal` | `order.priceDetails.discount` | `order.priceDetails.tax.name` | `order.priceDetails.tax.includedInPrice` | `order.priceDetails.tax.rate` | `order.priceDetails.tax.amount` | `order.priceDetails.total` | `order.priceDetails.planPrice` | `order.priceDetails.currency` | `order.priceDetails.coupon.code` | `order.priceDetails.coupon.amount` | `order.priceDetails.coupon._id` | `order.pricing.prices` | `order.pricing.prices.${number}.duration.cycleFrom` | `order.pricing.prices.${number}.price.subtotal` | `order.pricing.prices.${number}.price.discount` | `order.pricing.prices.${number}.price.total` | `order.pricing.prices.${number}.price.currency` | `order.pricing.prices.${number}.price.proration` | `order.type` | `order.status` | `order.cancellation.cause` | `order.cancellation.effectiveAt` | `order.lastPaymentStatus` | `order.pausePeriods` | `order.pausePeriods.${number}.status` | `order.currentCycle.index` | `order.planName` | `order.planDescription` | `order.planPrice`, 7> & {
|
|
2449
2438
|
__applicationErrorsType?: CreateOfflineOrderApplicationErrors;
|
|
2450
2439
|
__validationErrorsType?: CreateOfflineOrderValidationErrors;
|
|
2451
2440
|
}>;
|
|
@@ -2488,9 +2477,7 @@ interface CreateOfflineOrderOptions {
|
|
|
2488
2477
|
* @applicableIdentity MEMBER
|
|
2489
2478
|
* @fqn com.wixpress.membership.v2.orders.CheckoutService.GetOnlineOrderPreview
|
|
2490
2479
|
*/
|
|
2491
|
-
declare function getOnlineOrderPreview(planId: string, options?: GetOnlineOrderPreviewOptions): Promise<NonNullablePaths<GetOnlineOrderPreviewResponse, {
|
|
2492
|
-
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
2493
|
-
}[OrderNonNullablePaths] | `purchaseLimitExceeded`> & {
|
|
2480
|
+
declare function getOnlineOrderPreview(planId: string, options?: GetOnlineOrderPreviewOptions): Promise<NonNullablePaths<GetOnlineOrderPreviewResponse, `order._id` | `order.planId` | `order.subscriptionId` | `order.buyer.memberId` | `order.buyer.contactId` | `order.priceDetails.subscription.cycleDuration.unit` | `order.priceDetails.subtotal` | `order.priceDetails.discount` | `order.priceDetails.tax.name` | `order.priceDetails.tax.includedInPrice` | `order.priceDetails.tax.rate` | `order.priceDetails.tax.amount` | `order.priceDetails.total` | `order.priceDetails.planPrice` | `order.priceDetails.currency` | `order.priceDetails.coupon.code` | `order.priceDetails.coupon.amount` | `order.priceDetails.coupon._id` | `order.pricing.prices` | `order.pricing.prices.${number}.duration.cycleFrom` | `order.pricing.prices.${number}.price.subtotal` | `order.pricing.prices.${number}.price.discount` | `order.pricing.prices.${number}.price.total` | `order.pricing.prices.${number}.price.currency` | `order.pricing.prices.${number}.price.proration` | `order.type` | `order.status` | `order.cancellation.cause` | `order.cancellation.effectiveAt` | `order.lastPaymentStatus` | `order.pausePeriods` | `order.pausePeriods.${number}.status` | `order.currentCycle.index` | `order.planName` | `order.planDescription` | `order.planPrice` | `purchaseLimitExceeded`, 7> & {
|
|
2494
2481
|
__applicationErrorsType?: GetOnlineOrderPreviewApplicationErrors;
|
|
2495
2482
|
__validationErrorsType?: GetOnlineOrderPreviewValidationErrors;
|
|
2496
2483
|
}>;
|
|
@@ -2530,9 +2517,7 @@ interface GetOnlineOrderPreviewOptions {
|
|
|
2530
2517
|
* @applicableIdentity APP
|
|
2531
2518
|
* @fqn com.wixpress.membership.v2.orders.CheckoutService.GetOfflineOrderPreview
|
|
2532
2519
|
*/
|
|
2533
|
-
declare function getOfflineOrderPreview(planId: string, memberId: string, options?: GetOfflineOrderPreviewOptions): Promise<NonNullablePaths<GetOfflineOrderPreviewResponse, {
|
|
2534
|
-
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
2535
|
-
}[OrderNonNullablePaths] | `purchaseLimitExceeded`> & {
|
|
2520
|
+
declare function getOfflineOrderPreview(planId: string, memberId: string, options?: GetOfflineOrderPreviewOptions): Promise<NonNullablePaths<GetOfflineOrderPreviewResponse, `order._id` | `order.planId` | `order.subscriptionId` | `order.buyer.memberId` | `order.buyer.contactId` | `order.priceDetails.subscription.cycleDuration.unit` | `order.priceDetails.subtotal` | `order.priceDetails.discount` | `order.priceDetails.tax.name` | `order.priceDetails.tax.includedInPrice` | `order.priceDetails.tax.rate` | `order.priceDetails.tax.amount` | `order.priceDetails.total` | `order.priceDetails.planPrice` | `order.priceDetails.currency` | `order.priceDetails.coupon.code` | `order.priceDetails.coupon.amount` | `order.priceDetails.coupon._id` | `order.pricing.prices` | `order.pricing.prices.${number}.duration.cycleFrom` | `order.pricing.prices.${number}.price.subtotal` | `order.pricing.prices.${number}.price.discount` | `order.pricing.prices.${number}.price.total` | `order.pricing.prices.${number}.price.currency` | `order.pricing.prices.${number}.price.proration` | `order.type` | `order.status` | `order.cancellation.cause` | `order.cancellation.effectiveAt` | `order.lastPaymentStatus` | `order.pausePeriods` | `order.pausePeriods.${number}.status` | `order.currentCycle.index` | `order.planName` | `order.planDescription` | `order.planPrice` | `purchaseLimitExceeded`, 7> & {
|
|
2536
2521
|
__applicationErrorsType?: GetOfflineOrderPreviewApplicationErrors;
|
|
2537
2522
|
__validationErrorsType?: GetOfflineOrderPreviewValidationErrors;
|
|
2538
2523
|
}>;
|
|
@@ -2565,10 +2550,9 @@ interface GetOfflineOrderPreviewOptions {
|
|
|
2565
2550
|
* @param options - Options for getting a price preview.
|
|
2566
2551
|
* @permissionId PRICING_PLANS.READ_PUBLIC_PLANS
|
|
2567
2552
|
* @applicableIdentity APP
|
|
2568
|
-
* @applicableIdentity VISITOR
|
|
2569
2553
|
* @fqn com.wixpress.membership.v2.orders.CheckoutService.GetPricePreview
|
|
2570
2554
|
*/
|
|
2571
|
-
declare function getPricePreview(planId: string, options?: GetPricePreviewOptions): Promise<NonNullablePaths<GetPricePreviewResponse, `price.subscription.cycleDuration.unit` | `price.subtotal` | `price.discount` | `price.tax.name` | `price.tax.includedInPrice` | `price.tax.rate` | `price.tax.amount` | `price.total` | `price.planPrice` | `price.currency` | `price.coupon.code` | `price.coupon.amount` | `price.coupon._id` | `prices` | `prices.${number}.duration.cycleFrom` | `prices.${number}.price.subtotal` | `prices.${number}.price.coupon.code` | `prices.${number}.price.coupon.amount` | `prices.${number}.price.coupon._id` | `prices.${number}.price.discount` | `prices.${number}.price.tax.name` | `prices.${number}.price.tax.includedInPrice` | `prices.${number}.price.tax.rate` | `prices.${number}.price.tax.amount` | `prices.${number}.price.total` | `prices.${number}.price.currency` | `prices.${number}.price.proration
|
|
2555
|
+
declare function getPricePreview(planId: string, options?: GetPricePreviewOptions): Promise<NonNullablePaths<GetPricePreviewResponse, `price.subscription.cycleDuration.unit` | `price.subtotal` | `price.discount` | `price.tax.name` | `price.tax.includedInPrice` | `price.tax.rate` | `price.tax.amount` | `price.total` | `price.planPrice` | `price.currency` | `price.coupon.code` | `price.coupon.amount` | `price.coupon._id` | `prices` | `prices.${number}.duration.cycleFrom` | `prices.${number}.price.subtotal` | `prices.${number}.price.coupon.code` | `prices.${number}.price.coupon.amount` | `prices.${number}.price.coupon._id` | `prices.${number}.price.discount` | `prices.${number}.price.tax.name` | `prices.${number}.price.tax.includedInPrice` | `prices.${number}.price.tax.rate` | `prices.${number}.price.tax.amount` | `prices.${number}.price.total` | `prices.${number}.price.currency` | `prices.${number}.price.proration`, 6> & {
|
|
2572
2556
|
__applicationErrorsType?: GetPricePreviewApplicationErrors;
|
|
2573
2557
|
}>;
|
|
2574
2558
|
interface GetPricePreviewOptions {
|