@wix/auto_sdk_pricing-plans_orders 1.0.106 → 1.0.107
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 +39 -39
- package/build/cjs/index.js +283 -283
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +158 -158
- package/build/cjs/index.typings.js +254 -254
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +83 -83
- package/build/cjs/meta.js +198 -198
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +39 -39
- package/build/es/index.mjs +283 -283
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +158 -158
- package/build/es/index.typings.mjs +254 -254
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +83 -83
- package/build/es/meta.mjs +198 -198
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +39 -39
- package/build/internal/cjs/index.js +283 -283
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +158 -158
- package/build/internal/cjs/index.typings.js +254 -254
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +83 -83
- package/build/internal/cjs/meta.js +198 -198
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +39 -39
- package/build/internal/es/index.mjs +283 -283
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +158 -158
- package/build/internal/es/index.typings.mjs +254 -254
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +83 -83
- package/build/internal/es/meta.mjs +198 -198
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
package/build/cjs/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
-
import { ManagementGetOrderOptions, GetOrderResponse, ManagementListOrdersOptions, ListOrdersResponse, CancellationEffectiveAtWithLiterals,
|
|
2
|
+
import { ManagementGetOrderOptions, GetOrderResponse, ManagementListOrdersOptions, ListOrdersResponse, CancellationEffectiveAtWithLiterals, CreateOnlineOrderOptions, CreateOnlineOrderResponse, CreateOnlineOrderApplicationErrors, CreateOnlineOrderValidationErrors, CreateOfflineOrderOptions, CreateOfflineOrderResponse, CreateOfflineOrderApplicationErrors, CreateOfflineOrderValidationErrors, GetOnlineOrderPreviewOptions, GetOnlineOrderPreviewResponse, GetOnlineOrderPreviewApplicationErrors, GetOnlineOrderPreviewValidationErrors, GetOfflineOrderPreviewOptions, GetOfflineOrderPreviewResponse, GetOfflineOrderPreviewApplicationErrors, GetOfflineOrderPreviewValidationErrors, GetPricePreviewOptions, GetPricePreviewResponse, GetPricePreviewApplicationErrors, MemberGetOrderOptions, Order, MemberListOrdersOptions, MemberListOrdersResponse, OrderAutoRenewCanceledEnvelope, OrderCanceledEnvelope, OrderCycleStartedEnvelope, OrderEndDatePostponedEnvelope, OrderEndedEnvelope, OrderMarkedAsPaidEnvelope, OrderPausedEnvelope, OrderPurchasedEnvelope, OrderResumedEnvelope, OrderStartedEnvelope, OrderUpdatedEnvelope, OrderCreatedEnvelope, OrderStartDateChangedEnvelope } from './index.typings.js';
|
|
3
3
|
export { AccountInfo, AccountInfoMetadata, ActionEvent, ApplicationError, ApplyCouponRequest, ApplyCouponResponse, BaseEventMetadata, BulkActionMetadata, BulkOrderResult, BulkPauseOrderRequest, BulkPauseOrderResponse, BulkResumeOrderRequest, BulkResumeOrderResponse, Buyer, CancelOrderRequest, CancelOrderResponse, Cancellation, CancellationCause, CancellationCauseWithLiterals, CancellationEffectiveAt, Captcha, ChangeStartDateRequest, ChangeStartDateResponse, Coupon, CouponsError, CreateExternalOrderRequest, CreateExternalOrderResponse, CreateGuestOnlineOrderRequest, CreateGuestOnlineOrderResponse, CreateOfflineOrderRequest, CreateOnlineOrderRequest, CurrentCycle, CursorPaging, Cursors, DomainEvent, DomainEventBodyOneOf, Duration, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, Fee, FormData, GetAvailableOrderActionsRequest, GetAvailableOrderActionsResponse, GetGuestOnlineOrderPreviewRequest, GetGuestOnlineOrderPreviewResponse, GetOfflineOrderPreviewRequest, GetOnlineOrderPreviewRequest, GetOrderRequest, GetOrdersStatsRequest, GetOrdersStatsResponse, GetPricePreviewRequest, Guest, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, ListOrdersRequest, MarkAsPaidRequest, MarkAsPaidResponse, MemberGetOrderRequest, MemberGetOrderResponse, MemberListOrdersRequest, MessageEnvelope, OnBehalf, OrderAutoRenewCanceled, OrderCanceled, OrderCycle, OrderCycleStarted, OrderEndDatePostponed, OrderEnded, OrderMarkedAsPaid, OrderMethod, OrderMethodWithLiterals, OrderPaused, OrderPurchased, OrderResumed, OrderStartDateChanged, OrderStarted, OrderStatus, OrderStatusWithLiterals, OrderType, OrderTypeWithLiterals, OrdersQueryOrdersRequest, OrdersQueryOrdersResponse, Paging, PagingMetadataV2, PauseOrderRequest, PauseOrderResponse, PausePeriod, PaymentStatus, PaymentStatusWithLiterals, PeriodUnit, PeriodUnitWithLiterals, PostponeEndDateRequest, PostponeEndDateResponse, Price, PriceDetails, PriceDetailsPricingModelOneOf, PriceDuration, PricingDetails, PricingDetailsPricingModelOneOf, QueryOrdersRequest, QueryOrdersResponse, QueryV2, QueryV2PagingMethodOneOf, ReasonNotSuspendable, ReasonNotSuspendableWithLiterals, Recurrence, RequestCancellationRequest, RequestCancellationResponse, RestoreInfo, ResumeOrderRequest, ResumeOrderResponse, Set, SetSubmissionRequest, SetSubmissionResponse, SetWithLiterals, SortOrder, SortOrderWithLiterals, Sorting, SpannedPrice, Status, StatusWithLiterals, Tax, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
|
|
4
4
|
|
|
5
5
|
declare function managementGetOrder$1(httpClient: HttpClient): ManagementGetOrderSignature;
|
|
@@ -111,41 +111,6 @@ interface ResumeOrderSignature {
|
|
|
111
111
|
*/
|
|
112
112
|
(_id: string): Promise<void>;
|
|
113
113
|
}
|
|
114
|
-
declare function memberGetOrder$1(httpClient: HttpClient): MemberGetOrderSignature;
|
|
115
|
-
interface MemberGetOrderSignature {
|
|
116
|
-
/**
|
|
117
|
-
* Retrieves an order for the currently logged-in member by ID.
|
|
118
|
-
* @param - Order ID.
|
|
119
|
-
* @param - Options for getting a logged-in member's order.
|
|
120
|
-
* @returns Requested order.
|
|
121
|
-
*/
|
|
122
|
-
(_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>>;
|
|
123
|
-
}
|
|
124
|
-
declare function memberListOrders$1(httpClient: HttpClient): MemberListOrdersSignature;
|
|
125
|
-
interface MemberListOrdersSignature {
|
|
126
|
-
/**
|
|
127
|
-
* Retrieves a list of up to 100 pricing plan orders for currently logged-in member.
|
|
128
|
-
* @param - Filtering, sorting, and pagination options.
|
|
129
|
-
*/
|
|
130
|
-
(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>>;
|
|
131
|
-
}
|
|
132
|
-
declare function requestCancellation$1(httpClient: HttpClient): RequestCancellationSignature;
|
|
133
|
-
interface RequestCancellationSignature {
|
|
134
|
-
/**
|
|
135
|
-
* Cancels an order. Recurring orders can be canceled either immediately or at the next payment date. One time orders can only be canceled immediately.
|
|
136
|
-
*
|
|
137
|
-
* There may be some operations that continue to be processed before the status of the order is changed to `"CANCELED"`. For example, payments might need to be refunded before the order is fully canceled.
|
|
138
|
-
*
|
|
139
|
-
* Canceling during the free trial period: When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end of the free trial period and they won't be billed. The buyer may continue using the benefits until the end of the free trial period.
|
|
140
|
-
*
|
|
141
|
-
* >**Note:**
|
|
142
|
-
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
|
|
143
|
-
* @param - Order ID.
|
|
144
|
-
* @param - Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately.
|
|
145
|
-
* @param - Options for requesting a cancellation.
|
|
146
|
-
*/
|
|
147
|
-
(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
148
|
-
}
|
|
149
114
|
declare function createOnlineOrder$1(httpClient: HttpClient): CreateOnlineOrderSignature;
|
|
150
115
|
interface CreateOnlineOrderSignature {
|
|
151
116
|
/**
|
|
@@ -246,6 +211,41 @@ interface GetPricePreviewSignature {
|
|
|
246
211
|
__applicationErrorsType?: GetPricePreviewApplicationErrors;
|
|
247
212
|
}>;
|
|
248
213
|
}
|
|
214
|
+
declare function memberGetOrder$1(httpClient: HttpClient): MemberGetOrderSignature;
|
|
215
|
+
interface MemberGetOrderSignature {
|
|
216
|
+
/**
|
|
217
|
+
* Retrieves an order for the currently logged-in member by ID.
|
|
218
|
+
* @param - Order ID.
|
|
219
|
+
* @param - Options for getting a logged-in member's order.
|
|
220
|
+
* @returns Requested order.
|
|
221
|
+
*/
|
|
222
|
+
(_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>>;
|
|
223
|
+
}
|
|
224
|
+
declare function memberListOrders$1(httpClient: HttpClient): MemberListOrdersSignature;
|
|
225
|
+
interface MemberListOrdersSignature {
|
|
226
|
+
/**
|
|
227
|
+
* Retrieves a list of up to 100 pricing plan orders for currently logged-in member.
|
|
228
|
+
* @param - Filtering, sorting, and pagination options.
|
|
229
|
+
*/
|
|
230
|
+
(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>>;
|
|
231
|
+
}
|
|
232
|
+
declare function requestCancellation$1(httpClient: HttpClient): RequestCancellationSignature;
|
|
233
|
+
interface RequestCancellationSignature {
|
|
234
|
+
/**
|
|
235
|
+
* Cancels an order. Recurring orders can be canceled either immediately or at the next payment date. One time orders can only be canceled immediately.
|
|
236
|
+
*
|
|
237
|
+
* There may be some operations that continue to be processed before the status of the order is changed to `"CANCELED"`. For example, payments might need to be refunded before the order is fully canceled.
|
|
238
|
+
*
|
|
239
|
+
* Canceling during the free trial period: When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end of the free trial period and they won't be billed. The buyer may continue using the benefits until the end of the free trial period.
|
|
240
|
+
*
|
|
241
|
+
* >**Note:**
|
|
242
|
+
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
|
|
243
|
+
* @param - Order ID.
|
|
244
|
+
* @param - Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately.
|
|
245
|
+
* @param - Options for requesting a cancellation.
|
|
246
|
+
*/
|
|
247
|
+
(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
248
|
+
}
|
|
249
249
|
declare const onOrderAutoRenewCanceled$1: EventDefinition<OrderAutoRenewCanceledEnvelope, "wix.pricing_plans.v2.order_auto_renew_canceled">;
|
|
250
250
|
declare const onOrderCanceled$1: EventDefinition<OrderCanceledEnvelope, "wix.pricing_plans.v2.order_canceled">;
|
|
251
251
|
declare const onOrderCycleStarted$1: EventDefinition<OrderCycleStartedEnvelope, "wix.pricing_plans.v2.order_cycle_started">;
|
|
@@ -267,14 +267,14 @@ declare const cancelOrder: MaybeContext<BuildRESTFunction<typeof cancelOrder$1>
|
|
|
267
267
|
declare const markAsPaid: MaybeContext<BuildRESTFunction<typeof markAsPaid$1> & typeof markAsPaid$1>;
|
|
268
268
|
declare const pauseOrder: MaybeContext<BuildRESTFunction<typeof pauseOrder$1> & typeof pauseOrder$1>;
|
|
269
269
|
declare const resumeOrder: MaybeContext<BuildRESTFunction<typeof resumeOrder$1> & typeof resumeOrder$1>;
|
|
270
|
-
declare const memberGetOrder: MaybeContext<BuildRESTFunction<typeof memberGetOrder$1> & typeof memberGetOrder$1>;
|
|
271
|
-
declare const memberListOrders: MaybeContext<BuildRESTFunction<typeof memberListOrders$1> & typeof memberListOrders$1>;
|
|
272
|
-
declare const requestCancellation: MaybeContext<BuildRESTFunction<typeof requestCancellation$1> & typeof requestCancellation$1>;
|
|
273
270
|
declare const createOnlineOrder: MaybeContext<BuildRESTFunction<typeof createOnlineOrder$1> & typeof createOnlineOrder$1>;
|
|
274
271
|
declare const createOfflineOrder: MaybeContext<BuildRESTFunction<typeof createOfflineOrder$1> & typeof createOfflineOrder$1>;
|
|
275
272
|
declare const getOnlineOrderPreview: MaybeContext<BuildRESTFunction<typeof getOnlineOrderPreview$1> & typeof getOnlineOrderPreview$1>;
|
|
276
273
|
declare const getOfflineOrderPreview: MaybeContext<BuildRESTFunction<typeof getOfflineOrderPreview$1> & typeof getOfflineOrderPreview$1>;
|
|
277
274
|
declare const getPricePreview: MaybeContext<BuildRESTFunction<typeof getPricePreview$1> & typeof getPricePreview$1>;
|
|
275
|
+
declare const memberGetOrder: MaybeContext<BuildRESTFunction<typeof memberGetOrder$1> & typeof memberGetOrder$1>;
|
|
276
|
+
declare const memberListOrders: MaybeContext<BuildRESTFunction<typeof memberListOrders$1> & typeof memberListOrders$1>;
|
|
277
|
+
declare const requestCancellation: MaybeContext<BuildRESTFunction<typeof requestCancellation$1> & typeof requestCancellation$1>;
|
|
278
278
|
/**
|
|
279
279
|
* Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
|
|
280
280
|
*
|