@wix/auto_sdk_pricing-plans_orders 1.0.2 → 1.0.4
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/src/pricing-plans-v2-order-orders.context.d.ts +42 -42
- package/build/cjs/src/pricing-plans-v2-order-orders.context.js +46 -46
- package/build/cjs/src/pricing-plans-v2-order-orders.context.js.map +1 -1
- package/build/cjs/src/pricing-plans-v2-order-orders.http.d.ts +72 -72
- package/build/cjs/src/pricing-plans-v2-order-orders.http.js +343 -343
- package/build/cjs/src/pricing-plans-v2-order-orders.http.js.map +1 -1
- package/build/cjs/src/pricing-plans-v2-order-orders.meta.d.ts +12 -12
- package/build/cjs/src/pricing-plans-v2-order-orders.meta.js +89 -89
- package/build/cjs/src/pricing-plans-v2-order-orders.meta.js.map +1 -1
- package/build/cjs/src/pricing-plans-v2-order-orders.public.d.ts +113 -113
- package/build/cjs/src/pricing-plans-v2-order-orders.public.js +94 -94
- package/build/cjs/src/pricing-plans-v2-order-orders.public.js.map +1 -1
- package/build/cjs/src/pricing-plans-v2-order-orders.types.d.ts +640 -382
- package/build/cjs/src/pricing-plans-v2-order-orders.types.js +9 -9
- package/build/cjs/src/pricing-plans-v2-order-orders.types.js.map +1 -1
- package/build/cjs/src/pricing-plans-v2-order-orders.universal.d.ts +1042 -729
- package/build/cjs/src/pricing-plans-v2-order-orders.universal.js +387 -379
- package/build/cjs/src/pricing-plans-v2-order-orders.universal.js.map +1 -1
- package/build/es/src/pricing-plans-v2-order-orders.context.d.ts +42 -42
- package/build/es/src/pricing-plans-v2-order-orders.context.js +41 -41
- package/build/es/src/pricing-plans-v2-order-orders.context.js.map +1 -1
- package/build/es/src/pricing-plans-v2-order-orders.http.d.ts +72 -72
- package/build/es/src/pricing-plans-v2-order-orders.http.js +335 -335
- package/build/es/src/pricing-plans-v2-order-orders.http.js.map +1 -1
- package/build/es/src/pricing-plans-v2-order-orders.meta.d.ts +12 -12
- package/build/es/src/pricing-plans-v2-order-orders.meta.js +73 -73
- package/build/es/src/pricing-plans-v2-order-orders.meta.js.map +1 -1
- package/build/es/src/pricing-plans-v2-order-orders.public.d.ts +113 -113
- package/build/es/src/pricing-plans-v2-order-orders.public.js +81 -81
- package/build/es/src/pricing-plans-v2-order-orders.public.js.map +1 -1
- package/build/es/src/pricing-plans-v2-order-orders.types.d.ts +640 -382
- package/build/es/src/pricing-plans-v2-order-orders.types.js +8 -8
- package/build/es/src/pricing-plans-v2-order-orders.types.js.map +1 -1
- package/build/es/src/pricing-plans-v2-order-orders.universal.d.ts +1042 -729
- package/build/es/src/pricing-plans-v2-order-orders.universal.js +371 -363
- package/build/es/src/pricing-plans-v2-order-orders.universal.js.map +1 -1
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.context.d.ts +42 -42
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.context.js +46 -46
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.context.js.map +1 -1
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.http.d.ts +72 -72
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.http.js +343 -343
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.http.js.map +1 -1
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.meta.d.ts +12 -12
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.meta.js +89 -89
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.meta.js.map +1 -1
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.public.d.ts +113 -113
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.public.js +94 -94
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.public.js.map +1 -1
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.types.d.ts +640 -382
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.types.js +9 -9
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.types.js.map +1 -1
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.universal.d.ts +1044 -731
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.universal.js +387 -379
- package/build/internal/cjs/src/pricing-plans-v2-order-orders.universal.js.map +1 -1
- package/build/internal/es/src/pricing-plans-v2-order-orders.context.d.ts +42 -42
- package/build/internal/es/src/pricing-plans-v2-order-orders.context.js +41 -41
- package/build/internal/es/src/pricing-plans-v2-order-orders.context.js.map +1 -1
- package/build/internal/es/src/pricing-plans-v2-order-orders.http.d.ts +72 -72
- package/build/internal/es/src/pricing-plans-v2-order-orders.http.js +335 -335
- package/build/internal/es/src/pricing-plans-v2-order-orders.http.js.map +1 -1
- package/build/internal/es/src/pricing-plans-v2-order-orders.meta.d.ts +12 -12
- package/build/internal/es/src/pricing-plans-v2-order-orders.meta.js +73 -73
- package/build/internal/es/src/pricing-plans-v2-order-orders.meta.js.map +1 -1
- package/build/internal/es/src/pricing-plans-v2-order-orders.public.d.ts +113 -113
- package/build/internal/es/src/pricing-plans-v2-order-orders.public.js +81 -81
- package/build/internal/es/src/pricing-plans-v2-order-orders.public.js.map +1 -1
- package/build/internal/es/src/pricing-plans-v2-order-orders.types.d.ts +640 -382
- package/build/internal/es/src/pricing-plans-v2-order-orders.types.js +8 -8
- package/build/internal/es/src/pricing-plans-v2-order-orders.types.js.map +1 -1
- package/build/internal/es/src/pricing-plans-v2-order-orders.universal.d.ts +1044 -731
- package/build/internal/es/src/pricing-plans-v2-order-orders.universal.js +371 -363
- package/build/internal/es/src/pricing-plans-v2-order-orders.universal.js.map +1 -1
- package/package.json +4 -4
|
@@ -1,11 +1,8 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { managementGetOrder as publicManagementGetOrder, managementListOrders as publicManagementListOrders, postponeEndDate as publicPostponeEndDate, cancelOrder as publicCancelOrder, markAsPaid as publicMarkAsPaid, pauseOrder as publicPauseOrder, resumeOrder as publicResumeOrder, memberGetOrder as publicMemberGetOrder, memberListOrders as publicMemberListOrders, requestCancellation as publicRequestCancellation, createOnlineOrder as publicCreateOnlineOrder, createOfflineOrder as publicCreateOfflineOrder, getOnlineOrderPreview as publicGetOnlineOrderPreview, getOfflineOrderPreview as publicGetOfflineOrderPreview, getPricePreview as publicGetPricePreview } from './pricing-plans-v2-order-orders.public.js';
|
|
2
2
|
import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
|
|
3
3
|
import { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';
|
|
4
|
-
import { onOrderCanceled as publicOnOrderCanceled } from './pricing-plans-v2-order-orders.public.js';
|
|
5
|
-
import { onOrderCreated as publicOnOrderCreated } from './pricing-plans-v2-order-orders.public.js';
|
|
6
|
-
import { onOrderStartDateChanged as publicOnOrderStartDateChanged } from './pricing-plans-v2-order-orders.public.js';
|
|
7
|
-
import { onOrderUpdated as publicOnOrderUpdated } from './pricing-plans-v2-order-orders.public.js';
|
|
8
4
|
import { onOrderAutoRenewCanceled as publicOnOrderAutoRenewCanceled } from './pricing-plans-v2-order-orders.public.js';
|
|
5
|
+
import { onOrderCanceled as publicOnOrderCanceled } from './pricing-plans-v2-order-orders.public.js';
|
|
9
6
|
import { onOrderCycleStarted as publicOnOrderCycleStarted } from './pricing-plans-v2-order-orders.public.js';
|
|
10
7
|
import { onOrderEndDatePostponed as publicOnOrderEndDatePostponed } from './pricing-plans-v2-order-orders.public.js';
|
|
11
8
|
import { onOrderEnded as publicOnOrderEnded } from './pricing-plans-v2-order-orders.public.js';
|
|
@@ -14,6 +11,16 @@ import { onOrderPaused as publicOnOrderPaused } from './pricing-plans-v2-order-o
|
|
|
14
11
|
import { onOrderPurchased as publicOnOrderPurchased } from './pricing-plans-v2-order-orders.public.js';
|
|
15
12
|
import { onOrderResumed as publicOnOrderResumed } from './pricing-plans-v2-order-orders.public.js';
|
|
16
13
|
import { onOrderStarted as publicOnOrderStarted } from './pricing-plans-v2-order-orders.public.js';
|
|
14
|
+
import { onOrderUpdated as publicOnOrderUpdated } from './pricing-plans-v2-order-orders.public.js';
|
|
15
|
+
import { onOrderCreated as publicOnOrderCreated } from './pricing-plans-v2-order-orders.public.js';
|
|
16
|
+
import { onOrderStartDateChanged as publicOnOrderStartDateChanged } from './pricing-plans-v2-order-orders.public.js';
|
|
17
|
+
export declare const managementGetOrder: MaybeContext<BuildRESTFunction<typeof publicManagementGetOrder> & typeof publicManagementGetOrder>;
|
|
18
|
+
export declare const managementListOrders: MaybeContext<BuildRESTFunction<typeof publicManagementListOrders> & typeof publicManagementListOrders>;
|
|
19
|
+
export declare const postponeEndDate: MaybeContext<BuildRESTFunction<typeof publicPostponeEndDate> & typeof publicPostponeEndDate>;
|
|
20
|
+
export declare const cancelOrder: MaybeContext<BuildRESTFunction<typeof publicCancelOrder> & typeof publicCancelOrder>;
|
|
21
|
+
export declare const markAsPaid: MaybeContext<BuildRESTFunction<typeof publicMarkAsPaid> & typeof publicMarkAsPaid>;
|
|
22
|
+
export declare const pauseOrder: MaybeContext<BuildRESTFunction<typeof publicPauseOrder> & typeof publicPauseOrder>;
|
|
23
|
+
export declare const resumeOrder: MaybeContext<BuildRESTFunction<typeof publicResumeOrder> & typeof publicResumeOrder>;
|
|
17
24
|
export declare const memberGetOrder: MaybeContext<BuildRESTFunction<typeof publicMemberGetOrder> & typeof publicMemberGetOrder>;
|
|
18
25
|
export declare const memberListOrders: MaybeContext<BuildRESTFunction<typeof publicMemberListOrders> & typeof publicMemberListOrders>;
|
|
19
26
|
export declare const requestCancellation: MaybeContext<BuildRESTFunction<typeof publicRequestCancellation> & typeof publicRequestCancellation>;
|
|
@@ -22,41 +29,6 @@ export declare const createOfflineOrder: MaybeContext<BuildRESTFunction<typeof p
|
|
|
22
29
|
export declare const getOnlineOrderPreview: MaybeContext<BuildRESTFunction<typeof publicGetOnlineOrderPreview> & typeof publicGetOnlineOrderPreview>;
|
|
23
30
|
export declare const getOfflineOrderPreview: MaybeContext<BuildRESTFunction<typeof publicGetOfflineOrderPreview> & typeof publicGetOfflineOrderPreview>;
|
|
24
31
|
export declare const getPricePreview: MaybeContext<BuildRESTFunction<typeof publicGetPricePreview> & typeof publicGetPricePreview>;
|
|
25
|
-
export declare const managementGetOrder: MaybeContext<BuildRESTFunction<typeof publicManagementGetOrder> & typeof publicManagementGetOrder>;
|
|
26
|
-
export declare const managementListOrders: MaybeContext<BuildRESTFunction<typeof publicManagementListOrders> & typeof publicManagementListOrders>;
|
|
27
|
-
export declare const postponeEndDate: MaybeContext<BuildRESTFunction<typeof publicPostponeEndDate> & typeof publicPostponeEndDate>;
|
|
28
|
-
export declare const cancelOrder: MaybeContext<BuildRESTFunction<typeof publicCancelOrder> & typeof publicCancelOrder>;
|
|
29
|
-
export declare const markAsPaid: MaybeContext<BuildRESTFunction<typeof publicMarkAsPaid> & typeof publicMarkAsPaid>;
|
|
30
|
-
export declare const pauseOrder: MaybeContext<BuildRESTFunction<typeof publicPauseOrder> & typeof publicPauseOrder>;
|
|
31
|
-
export declare const resumeOrder: MaybeContext<BuildRESTFunction<typeof publicResumeOrder> & typeof publicResumeOrder>;
|
|
32
|
-
/**
|
|
33
|
-
* Triggered when an order is canceled.
|
|
34
|
-
*
|
|
35
|
-
* This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
|
|
36
|
-
* + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
|
|
37
|
-
* + If the order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`, the webhook is triggered at the end of the current payment cycle. In this case, the Order Auto Renew Canceled Webhook is triggered immediately.
|
|
38
|
-
*/
|
|
39
|
-
export declare const onOrderCanceled: ReturnType<typeof createEventModule<typeof publicOnOrderCanceled>>;
|
|
40
|
-
/**
|
|
41
|
-
* Triggered when an order is created.
|
|
42
|
-
*/
|
|
43
|
-
export declare const onOrderCreated: ReturnType<typeof createEventModule<typeof publicOnOrderCreated>>;
|
|
44
|
-
/**
|
|
45
|
-
* Triggered when an order's `startDate` is changed.
|
|
46
|
-
*/
|
|
47
|
-
export declare const onOrderStartDateChanged: ReturnType<typeof createEventModule<typeof publicOnOrderStartDateChanged>>;
|
|
48
|
-
/**
|
|
49
|
-
* Triggered for any of the following update events:
|
|
50
|
-
*
|
|
51
|
-
* + Order is paid for. Order Purchased is also triggered.
|
|
52
|
-
* + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
|
|
53
|
-
* + New payment cycle of an order starts. Order Cycle Started is also triggered.
|
|
54
|
-
* + Offline order is marked as paid. Order Marked As Paid is also triggered.
|
|
55
|
-
* + End date of the order is postponed. Order End Date Postponed is also triggered
|
|
56
|
-
* + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
|
|
57
|
-
* + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
|
|
58
|
-
*/
|
|
59
|
-
export declare const onOrderUpdated: ReturnType<typeof createEventModule<typeof publicOnOrderUpdated>>;
|
|
60
32
|
/**
|
|
61
33
|
* Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
|
|
62
34
|
*
|
|
@@ -65,6 +37,14 @@ export declare const onOrderUpdated: ReturnType<typeof createEventModule<typeof
|
|
|
65
37
|
* + When an order expires at the end of the current payment cycle because it was canceled and `effectiveAt` was set to `NEXT_PAYMENT_DATE`. Instead, at the time of expiration, Order Canceled and Order Ended are triggered.
|
|
66
38
|
*/
|
|
67
39
|
export declare const onOrderAutoRenewCanceled: ReturnType<typeof createEventModule<typeof publicOnOrderAutoRenewCanceled>>;
|
|
40
|
+
/**
|
|
41
|
+
* Triggered when an order is canceled.
|
|
42
|
+
*
|
|
43
|
+
* This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
|
|
44
|
+
* + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
|
|
45
|
+
* + If the order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`, the webhook is triggered at the end of the current payment cycle. In this case, the Order Auto Renew Canceled Webhook is triggered immediately.
|
|
46
|
+
*/
|
|
47
|
+
export declare const onOrderCanceled: ReturnType<typeof createEventModule<typeof publicOnOrderCanceled>>;
|
|
68
48
|
/**
|
|
69
49
|
* Triggered at the start of a new payment cycle for an existing order.
|
|
70
50
|
*
|
|
@@ -107,5 +87,25 @@ export declare const onOrderResumed: ReturnType<typeof createEventModule<typeof
|
|
|
107
87
|
* Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
|
|
108
88
|
*/
|
|
109
89
|
export declare const onOrderStarted: ReturnType<typeof createEventModule<typeof publicOnOrderStarted>>;
|
|
110
|
-
|
|
111
|
-
|
|
90
|
+
/**
|
|
91
|
+
* Triggered for any of the following update events:
|
|
92
|
+
*
|
|
93
|
+
* + Order is paid for. Order Purchased is also triggered.
|
|
94
|
+
* + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
|
|
95
|
+
* + New payment cycle of an order starts. Order Cycle Started is also triggered.
|
|
96
|
+
* + Offline order is marked as paid. Order Marked As Paid is also triggered.
|
|
97
|
+
* + End date of the order is postponed. Order End Date Postponed is also triggered
|
|
98
|
+
* + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
|
|
99
|
+
* + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
|
|
100
|
+
*/
|
|
101
|
+
export declare const onOrderUpdated: ReturnType<typeof createEventModule<typeof publicOnOrderUpdated>>;
|
|
102
|
+
/**
|
|
103
|
+
* Triggered when an order is created.
|
|
104
|
+
*/
|
|
105
|
+
export declare const onOrderCreated: ReturnType<typeof createEventModule<typeof publicOnOrderCreated>>;
|
|
106
|
+
/**
|
|
107
|
+
* Triggered when an order's `startDate` is changed.
|
|
108
|
+
*/
|
|
109
|
+
export declare const onOrderStartDateChanged: ReturnType<typeof createEventModule<typeof publicOnOrderStartDateChanged>>;
|
|
110
|
+
export { PeriodUnit, OrderType, OrderMethod, OrderStatus, CancellationCause, CancellationEffectiveAt, PaymentStatus, Status, Set, SortOrder, ReasonNotSuspendable, WebhookIdentityType, } from './pricing-plans-v2-order-orders.universal.js';
|
|
111
|
+
export { Order, Buyer, PriceDetails, PriceDetailsPricingModelOneOf, Tax, Recurrence, Duration, Coupon, PricingDetails, PricingDetailsPricingModelOneOf, SpannedPrice, PriceDuration, Price, Fee, Cancellation, PausePeriod, CurrentCycle, OrderCycle, FormData, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, RestoreInfo, EntityUpdatedEvent, EntityDeletedEvent, ActionEvent, Empty, OrderPurchased, OrderStarted, OrderCycleStarted, OrderAutoRenewCanceled, OrderEnded, GetOrderRequest, GetOrderResponse, ListOrdersRequest, Sorting, ListOrdersResponse, PagingMetadataV2, Cursors, OrdersQueryOrdersRequest, QueryV2, QueryV2PagingMethodOneOf, Paging, CursorPaging, OrdersQueryOrdersResponse, GetOrdersStatsRequest, GetOrdersStatsResponse, GetAvailableOrderActionsRequest, GetAvailableOrderActionsResponse, PostponeEndDateRequest, PostponeEndDateResponse, OrderEndDatePostponed, CancelOrderRequest, CancelOrderResponse, OrderCanceled, MarkAsPaidRequest, MarkAsPaidResponse, OrderMarkedAsPaid, PauseOrderRequest, PauseOrderResponse, OrderPaused, BulkPauseOrderRequest, BulkPauseOrderResponse, BulkOrderResult, ItemMetadata, ApplicationError, BulkActionMetadata, ResumeOrderRequest, ResumeOrderResponse, OrderResumed, BulkResumeOrderRequest, BulkResumeOrderResponse, MessageEnvelope, IdentificationData, IdentificationDataIdOneOf, MemberGetOrderRequest, MemberGetOrderResponse, MemberListOrdersRequest, MemberListOrdersResponse, QueryOrdersRequest, QueryOrdersResponse, RequestCancellationRequest, RequestCancellationResponse, CreateOnlineOrderRequest, OnBehalf, CreateOnlineOrderResponse, CouponsError, CreateGuestOnlineOrderRequest, Captcha, Guest, CreateGuestOnlineOrderResponse, CreateOfflineOrderRequest, CreateOfflineOrderResponse, CreateExternalOrderRequest, CreateExternalOrderResponse, GetOnlineOrderPreviewRequest, GetOnlineOrderPreviewResponse, GetGuestOnlineOrderPreviewRequest, GetGuestOnlineOrderPreviewResponse, GetOfflineOrderPreviewRequest, GetOfflineOrderPreviewResponse, GetPricePreviewRequest, GetPricePreviewResponse, ChangeStartDateRequest, ChangeStartDateResponse, OrderStartDateChanged, ApplyCouponRequest, ApplyCouponResponse, SetSubmissionRequest, SetSubmissionResponse, OrderNonNullableFields, GetOrderResponseNonNullableFields, ListOrdersResponseNonNullableFields, MemberGetOrderResponseNonNullableFields, MemberListOrdersResponseNonNullableFields, CreateOnlineOrderResponseNonNullableFields, CreateOfflineOrderResponseNonNullableFields, GetOnlineOrderPreviewResponseNonNullableFields, GetOfflineOrderPreviewResponseNonNullableFields, GetPricePreviewResponseNonNullableFields, BaseEventMetadata, EventMetadata, OrderAutoRenewCanceledEnvelope, OrderCanceledEnvelope, OrderCycleStartedEnvelope, OrderEndDatePostponedEnvelope, OrderEndedEnvelope, OrderMarkedAsPaidEnvelope, OrderPausedEnvelope, OrderPurchasedEnvelope, OrderResumedEnvelope, OrderStartedEnvelope, OrderUpdatedEnvelope, OrderCreatedEnvelope, OrderStartDateChangedEnvelope, ManagementGetOrderOptions, ManagementListOrdersOptions, MemberGetOrderOptions, MemberListOrdersOptions, CreateOnlineOrderOptions, CreateOfflineOrderOptions, GetOnlineOrderPreviewOptions, GetOfflineOrderPreviewOptions, GetPricePreviewOptions, } from './pricing-plans-v2-order-orders.universal.js';
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.
|
|
3
|
+
exports.WebhookIdentityType = exports.ReasonNotSuspendable = exports.SortOrder = exports.Set = exports.Status = exports.PaymentStatus = exports.CancellationEffectiveAt = exports.CancellationCause = exports.OrderStatus = exports.OrderMethod = exports.OrderType = exports.PeriodUnit = exports.onOrderStartDateChanged = exports.onOrderCreated = exports.onOrderUpdated = exports.onOrderStarted = exports.onOrderResumed = exports.onOrderPurchased = exports.onOrderPaused = exports.onOrderMarkedAsPaid = exports.onOrderEnded = exports.onOrderEndDatePostponed = exports.onOrderCycleStarted = exports.onOrderCanceled = exports.onOrderAutoRenewCanceled = exports.getPricePreview = exports.getOfflineOrderPreview = exports.getOnlineOrderPreview = exports.createOfflineOrder = exports.createOnlineOrder = exports.requestCancellation = exports.memberListOrders = exports.memberGetOrder = exports.resumeOrder = exports.pauseOrder = exports.markAsPaid = exports.cancelOrder = exports.postponeEndDate = exports.managementListOrders = exports.managementGetOrder = void 0;
|
|
4
4
|
const pricing_plans_v2_order_orders_public_js_1 = require("./pricing-plans-v2-order-orders.public.js");
|
|
5
5
|
const rest_modules_1 = require("@wix/sdk-runtime/rest-modules");
|
|
6
6
|
const event_definition_modules_1 = require("@wix/sdk-runtime/event-definition-modules");
|
|
@@ -17,6 +17,13 @@ const pricing_plans_v2_order_orders_public_js_11 = require("./pricing-plans-v2-o
|
|
|
17
17
|
const pricing_plans_v2_order_orders_public_js_12 = require("./pricing-plans-v2-order-orders.public.js");
|
|
18
18
|
const pricing_plans_v2_order_orders_public_js_13 = require("./pricing-plans-v2-order-orders.public.js");
|
|
19
19
|
const pricing_plans_v2_order_orders_public_js_14 = require("./pricing-plans-v2-order-orders.public.js");
|
|
20
|
+
exports.managementGetOrder = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_order_orders_public_js_1.managementGetOrder);
|
|
21
|
+
exports.managementListOrders = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_order_orders_public_js_1.managementListOrders);
|
|
22
|
+
exports.postponeEndDate = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_order_orders_public_js_1.postponeEndDate);
|
|
23
|
+
exports.cancelOrder = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_order_orders_public_js_1.cancelOrder);
|
|
24
|
+
exports.markAsPaid = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_order_orders_public_js_1.markAsPaid);
|
|
25
|
+
exports.pauseOrder = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_order_orders_public_js_1.pauseOrder);
|
|
26
|
+
exports.resumeOrder = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_order_orders_public_js_1.resumeOrder);
|
|
20
27
|
exports.memberGetOrder = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_order_orders_public_js_1.memberGetOrder);
|
|
21
28
|
exports.memberListOrders = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_order_orders_public_js_1.memberListOrders);
|
|
22
29
|
exports.requestCancellation = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_order_orders_public_js_1.requestCancellation);
|
|
@@ -25,41 +32,6 @@ exports.createOfflineOrder = (0, rest_modules_1.createRESTModule)(pricing_plans_
|
|
|
25
32
|
exports.getOnlineOrderPreview = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_order_orders_public_js_1.getOnlineOrderPreview);
|
|
26
33
|
exports.getOfflineOrderPreview = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_order_orders_public_js_1.getOfflineOrderPreview);
|
|
27
34
|
exports.getPricePreview = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_order_orders_public_js_1.getPricePreview);
|
|
28
|
-
exports.managementGetOrder = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_order_orders_public_js_1.managementGetOrder);
|
|
29
|
-
exports.managementListOrders = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_order_orders_public_js_1.managementListOrders);
|
|
30
|
-
exports.postponeEndDate = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_order_orders_public_js_1.postponeEndDate);
|
|
31
|
-
exports.cancelOrder = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_order_orders_public_js_1.cancelOrder);
|
|
32
|
-
exports.markAsPaid = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_order_orders_public_js_1.markAsPaid);
|
|
33
|
-
exports.pauseOrder = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_order_orders_public_js_1.pauseOrder);
|
|
34
|
-
exports.resumeOrder = (0, rest_modules_1.createRESTModule)(pricing_plans_v2_order_orders_public_js_1.resumeOrder);
|
|
35
|
-
/**
|
|
36
|
-
* Triggered when an order is canceled.
|
|
37
|
-
*
|
|
38
|
-
* This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
|
|
39
|
-
* + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
|
|
40
|
-
* + If the order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`, the webhook is triggered at the end of the current payment cycle. In this case, the Order Auto Renew Canceled Webhook is triggered immediately.
|
|
41
|
-
*/
|
|
42
|
-
exports.onOrderCanceled = (0, event_definition_modules_1.createEventModule)(pricing_plans_v2_order_orders_public_js_2.onOrderCanceled);
|
|
43
|
-
/**
|
|
44
|
-
* Triggered when an order is created.
|
|
45
|
-
*/
|
|
46
|
-
exports.onOrderCreated = (0, event_definition_modules_1.createEventModule)(pricing_plans_v2_order_orders_public_js_3.onOrderCreated);
|
|
47
|
-
/**
|
|
48
|
-
* Triggered when an order's `startDate` is changed.
|
|
49
|
-
*/
|
|
50
|
-
exports.onOrderStartDateChanged = (0, event_definition_modules_1.createEventModule)(pricing_plans_v2_order_orders_public_js_4.onOrderStartDateChanged);
|
|
51
|
-
/**
|
|
52
|
-
* Triggered for any of the following update events:
|
|
53
|
-
*
|
|
54
|
-
* + Order is paid for. Order Purchased is also triggered.
|
|
55
|
-
* + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
|
|
56
|
-
* + New payment cycle of an order starts. Order Cycle Started is also triggered.
|
|
57
|
-
* + Offline order is marked as paid. Order Marked As Paid is also triggered.
|
|
58
|
-
* + End date of the order is postponed. Order End Date Postponed is also triggered
|
|
59
|
-
* + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
|
|
60
|
-
* + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
|
|
61
|
-
*/
|
|
62
|
-
exports.onOrderUpdated = (0, event_definition_modules_1.createEventModule)(pricing_plans_v2_order_orders_public_js_5.onOrderUpdated);
|
|
63
35
|
/**
|
|
64
36
|
* Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
|
|
65
37
|
*
|
|
@@ -67,17 +39,25 @@ exports.onOrderUpdated = (0, event_definition_modules_1.createEventModule)(prici
|
|
|
67
39
|
* + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
|
|
68
40
|
* + When an order expires at the end of the current payment cycle because it was canceled and `effectiveAt` was set to `NEXT_PAYMENT_DATE`. Instead, at the time of expiration, Order Canceled and Order Ended are triggered.
|
|
69
41
|
*/
|
|
70
|
-
exports.onOrderAutoRenewCanceled = (0, event_definition_modules_1.createEventModule)(
|
|
42
|
+
exports.onOrderAutoRenewCanceled = (0, event_definition_modules_1.createEventModule)(pricing_plans_v2_order_orders_public_js_2.onOrderAutoRenewCanceled);
|
|
43
|
+
/**
|
|
44
|
+
* Triggered when an order is canceled.
|
|
45
|
+
*
|
|
46
|
+
* This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
|
|
47
|
+
* + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
|
|
48
|
+
* + If the order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`, the webhook is triggered at the end of the current payment cycle. In this case, the Order Auto Renew Canceled Webhook is triggered immediately.
|
|
49
|
+
*/
|
|
50
|
+
exports.onOrderCanceled = (0, event_definition_modules_1.createEventModule)(pricing_plans_v2_order_orders_public_js_3.onOrderCanceled);
|
|
71
51
|
/**
|
|
72
52
|
* Triggered at the start of a new payment cycle for an existing order.
|
|
73
53
|
*
|
|
74
54
|
* Not triggered at the initial start of an offline order.
|
|
75
55
|
*/
|
|
76
|
-
exports.onOrderCycleStarted = (0, event_definition_modules_1.createEventModule)(
|
|
56
|
+
exports.onOrderCycleStarted = (0, event_definition_modules_1.createEventModule)(pricing_plans_v2_order_orders_public_js_4.onOrderCycleStarted);
|
|
77
57
|
/**
|
|
78
58
|
* Triggered when an order's `endDate` is postponed.
|
|
79
59
|
*/
|
|
80
|
-
exports.onOrderEndDatePostponed = (0, event_definition_modules_1.createEventModule)(
|
|
60
|
+
exports.onOrderEndDatePostponed = (0, event_definition_modules_1.createEventModule)(pricing_plans_v2_order_orders_public_js_5.onOrderEndDatePostponed);
|
|
81
61
|
/**
|
|
82
62
|
* Triggered when an order ends.
|
|
83
63
|
*
|
|
@@ -85,15 +65,15 @@ exports.onOrderEndDatePostponed = (0, event_definition_modules_1.createEventModu
|
|
|
85
65
|
* + When an order expires at the end of the current payment cycle.
|
|
86
66
|
* + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`.
|
|
87
67
|
*/
|
|
88
|
-
exports.onOrderEnded = (0, event_definition_modules_1.createEventModule)(
|
|
68
|
+
exports.onOrderEnded = (0, event_definition_modules_1.createEventModule)(pricing_plans_v2_order_orders_public_js_6.onOrderEnded);
|
|
89
69
|
/**
|
|
90
70
|
* Triggered when an offline order is marked as paid.
|
|
91
71
|
*/
|
|
92
|
-
exports.onOrderMarkedAsPaid = (0, event_definition_modules_1.createEventModule)(
|
|
72
|
+
exports.onOrderMarkedAsPaid = (0, event_definition_modules_1.createEventModule)(pricing_plans_v2_order_orders_public_js_7.onOrderMarkedAsPaid);
|
|
93
73
|
/**
|
|
94
74
|
* Triggered when an order is paused.
|
|
95
75
|
*/
|
|
96
|
-
exports.onOrderPaused = (0, event_definition_modules_1.createEventModule)(
|
|
76
|
+
exports.onOrderPaused = (0, event_definition_modules_1.createEventModule)(pricing_plans_v2_order_orders_public_js_8.onOrderPaused);
|
|
97
77
|
/**
|
|
98
78
|
* Triggered for any of the following purchase events:
|
|
99
79
|
* + Order is paid in full.
|
|
@@ -101,15 +81,35 @@ exports.onOrderPaused = (0, event_definition_modules_1.createEventModule)(pricin
|
|
|
101
81
|
* + Offline order is created, even if not yet marked as paid.
|
|
102
82
|
* + Free order is created.
|
|
103
83
|
*/
|
|
104
|
-
exports.onOrderPurchased = (0, event_definition_modules_1.createEventModule)(
|
|
84
|
+
exports.onOrderPurchased = (0, event_definition_modules_1.createEventModule)(pricing_plans_v2_order_orders_public_js_9.onOrderPurchased);
|
|
105
85
|
/**
|
|
106
86
|
* Triggered when a paused order is resumed.
|
|
107
87
|
*/
|
|
108
|
-
exports.onOrderResumed = (0, event_definition_modules_1.createEventModule)(
|
|
88
|
+
exports.onOrderResumed = (0, event_definition_modules_1.createEventModule)(pricing_plans_v2_order_orders_public_js_10.onOrderResumed);
|
|
109
89
|
/**
|
|
110
90
|
* Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
|
|
111
91
|
*/
|
|
112
|
-
exports.onOrderStarted = (0, event_definition_modules_1.createEventModule)(
|
|
92
|
+
exports.onOrderStarted = (0, event_definition_modules_1.createEventModule)(pricing_plans_v2_order_orders_public_js_11.onOrderStarted);
|
|
93
|
+
/**
|
|
94
|
+
* Triggered for any of the following update events:
|
|
95
|
+
*
|
|
96
|
+
* + Order is paid for. Order Purchased is also triggered.
|
|
97
|
+
* + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
|
|
98
|
+
* + New payment cycle of an order starts. Order Cycle Started is also triggered.
|
|
99
|
+
* + Offline order is marked as paid. Order Marked As Paid is also triggered.
|
|
100
|
+
* + End date of the order is postponed. Order End Date Postponed is also triggered
|
|
101
|
+
* + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
|
|
102
|
+
* + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
|
|
103
|
+
*/
|
|
104
|
+
exports.onOrderUpdated = (0, event_definition_modules_1.createEventModule)(pricing_plans_v2_order_orders_public_js_12.onOrderUpdated);
|
|
105
|
+
/**
|
|
106
|
+
* Triggered when an order is created.
|
|
107
|
+
*/
|
|
108
|
+
exports.onOrderCreated = (0, event_definition_modules_1.createEventModule)(pricing_plans_v2_order_orders_public_js_13.onOrderCreated);
|
|
109
|
+
/**
|
|
110
|
+
* Triggered when an order's `startDate` is changed.
|
|
111
|
+
*/
|
|
112
|
+
exports.onOrderStartDateChanged = (0, event_definition_modules_1.createEventModule)(pricing_plans_v2_order_orders_public_js_14.onOrderStartDateChanged);
|
|
113
113
|
var pricing_plans_v2_order_orders_universal_js_1 = require("./pricing-plans-v2-order-orders.universal.js");
|
|
114
114
|
Object.defineProperty(exports, "PeriodUnit", { enumerable: true, get: function () { return pricing_plans_v2_order_orders_universal_js_1.PeriodUnit; } });
|
|
115
115
|
Object.defineProperty(exports, "OrderType", { enumerable: true, get: function () { return pricing_plans_v2_order_orders_universal_js_1.OrderType; } });
|
|
@@ -121,6 +121,6 @@ Object.defineProperty(exports, "PaymentStatus", { enumerable: true, get: functio
|
|
|
121
121
|
Object.defineProperty(exports, "Status", { enumerable: true, get: function () { return pricing_plans_v2_order_orders_universal_js_1.Status; } });
|
|
122
122
|
Object.defineProperty(exports, "Set", { enumerable: true, get: function () { return pricing_plans_v2_order_orders_universal_js_1.Set; } });
|
|
123
123
|
Object.defineProperty(exports, "SortOrder", { enumerable: true, get: function () { return pricing_plans_v2_order_orders_universal_js_1.SortOrder; } });
|
|
124
|
-
Object.defineProperty(exports, "WebhookIdentityType", { enumerable: true, get: function () { return pricing_plans_v2_order_orders_universal_js_1.WebhookIdentityType; } });
|
|
125
124
|
Object.defineProperty(exports, "ReasonNotSuspendable", { enumerable: true, get: function () { return pricing_plans_v2_order_orders_universal_js_1.ReasonNotSuspendable; } });
|
|
125
|
+
Object.defineProperty(exports, "WebhookIdentityType", { enumerable: true, get: function () { return pricing_plans_v2_order_orders_universal_js_1.WebhookIdentityType; } });
|
|
126
126
|
//# sourceMappingURL=pricing-plans-v2-order-orders.context.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pricing-plans-v2-order-orders.context.js","sourceRoot":"","sources":["../../../src/pricing-plans-v2-order-orders.context.ts"],"names":[],"mappings":";;;AAAA,uGAgBmD;AACnD,gEAAiE;AACjE,wFAA8E;AAE9E,uGAAqG;AACrG,
|
|
1
|
+
{"version":3,"file":"pricing-plans-v2-order-orders.context.js","sourceRoot":"","sources":["../../../src/pricing-plans-v2-order-orders.context.ts"],"names":[],"mappings":";;;AAAA,uGAgBmD;AACnD,gEAAiE;AACjE,wFAA8E;AAE9E,uGAAuH;AACvH,uGAAqG;AACrG,uGAA6G;AAC7G,uGAAqH;AACrH,uGAA+F;AAC/F,uGAA6G;AAC7G,uGAAiG;AACjG,uGAAuG;AACvG,wGAAmG;AACnG,wGAAmG;AACnG,wGAAmG;AACnG,wGAAmG;AACnG,wGAAqH;AAExG,QAAA,kBAAkB,GAGb,IAAA,+BAAgB,EAAC,4DAAwB,CAAC,CAAC;AAChD,QAAA,oBAAoB,GAGf,IAAA,+BAAgB,EAAC,8DAA0B,CAAC,CAAC;AAClD,QAAA,eAAe,GAEV,IAAA,+BAAgB,EAAC,yDAAqB,CAAC,CAAC;AAC7C,QAAA,WAAW,GAEN,IAAA,+BAAgB,EAAC,qDAAiB,CAAC,CAAC;AACzC,QAAA,UAAU,GAEL,IAAA,+BAAgB,EAAC,oDAAgB,CAAC,CAAC;AACxC,QAAA,UAAU,GAEL,IAAA,+BAAgB,EAAC,oDAAgB,CAAC,CAAC;AACxC,QAAA,WAAW,GAEN,IAAA,+BAAgB,EAAC,qDAAiB,CAAC,CAAC;AACzC,QAAA,cAAc,GAET,IAAA,+BAAgB,EAAC,wDAAoB,CAAC,CAAC;AAC5C,QAAA,gBAAgB,GAGX,IAAA,+BAAgB,EAAC,0DAAsB,CAAC,CAAC;AAC9C,QAAA,mBAAmB,GAGd,IAAA,+BAAgB,EAAC,6DAAyB,CAAC,CAAC;AACjD,QAAA,iBAAiB,GAGZ,IAAA,+BAAgB,EAAC,2DAAuB,CAAC,CAAC;AAC/C,QAAA,kBAAkB,GAGb,IAAA,+BAAgB,EAAC,4DAAwB,CAAC,CAAC;AAChD,QAAA,qBAAqB,GAGhB,IAAA,+BAAgB,EAAC,+DAA2B,CAAC,CAAC;AACnD,QAAA,sBAAsB,GAGjB,IAAA,+BAAgB,EAAC,gEAA4B,CAAC,CAAC;AACpD,QAAA,eAAe,GAEV,IAAA,+BAAgB,EAAC,yDAAqB,CAAC,CAAC;AAC1D;;;;;;GAMG;AACU,QAAA,wBAAwB,GAEjC,IAAA,4CAAiB,EAAC,kEAA8B,CAAC,CAAC;AACtD;;;;;;GAMG;AACU,QAAA,eAAe,GAExB,IAAA,4CAAiB,EAAC,yDAAqB,CAAC,CAAC;AAC7C;;;;GAIG;AACU,QAAA,mBAAmB,GAE5B,IAAA,4CAAiB,EAAC,6DAAyB,CAAC,CAAC;AACjD;;GAEG;AACU,QAAA,uBAAuB,GAEhC,IAAA,4CAAiB,EAAC,iEAA6B,CAAC,CAAC;AACrD;;;;;;GAMG;AACU,QAAA,YAAY,GAErB,IAAA,4CAAiB,EAAC,sDAAkB,CAAC,CAAC;AAC1C;;GAEG;AACU,QAAA,mBAAmB,GAE5B,IAAA,4CAAiB,EAAC,6DAAyB,CAAC,CAAC;AACjD;;GAEG;AACU,QAAA,aAAa,GAEtB,IAAA,4CAAiB,EAAC,uDAAmB,CAAC,CAAC;AAC3C;;;;;;GAMG;AACU,QAAA,gBAAgB,GAEzB,IAAA,4CAAiB,EAAC,0DAAsB,CAAC,CAAC;AAC9C;;GAEG;AACU,QAAA,cAAc,GAEvB,IAAA,4CAAiB,EAAC,yDAAoB,CAAC,CAAC;AAC5C;;GAEG;AACU,QAAA,cAAc,GAEvB,IAAA,4CAAiB,EAAC,yDAAoB,CAAC,CAAC;AAC5C;;;;;;;;;;GAUG;AACU,QAAA,cAAc,GAEvB,IAAA,4CAAiB,EAAC,yDAAoB,CAAC,CAAC;AAC5C;;GAEG;AACU,QAAA,cAAc,GAEvB,IAAA,4CAAiB,EAAC,yDAAoB,CAAC,CAAC;AAC5C;;GAEG;AACU,QAAA,uBAAuB,GAEhC,IAAA,4CAAiB,EAAC,kEAA6B,CAAC,CAAC;AAErD,2GAasD;AAZpD,wIAAA,UAAU,OAAA;AACV,uIAAA,SAAS,OAAA;AACT,yIAAA,WAAW,OAAA;AACX,yIAAA,WAAW,OAAA;AACX,+IAAA,iBAAiB,OAAA;AACjB,qJAAA,uBAAuB,OAAA;AACvB,2IAAA,aAAa,OAAA;AACb,oIAAA,MAAM,OAAA;AACN,iIAAA,GAAG,OAAA;AACH,uIAAA,SAAS,OAAA;AACT,kJAAA,oBAAoB,OAAA;AACpB,iJAAA,mBAAmB,OAAA"}
|
|
@@ -1,4 +1,76 @@
|
|
|
1
1
|
import { RequestOptionsFactory } from '@wix/sdk-types';
|
|
2
|
+
/** Retrieves an order by ID. */
|
|
3
|
+
export declare function managementGetOrder(payload: object): RequestOptionsFactory<any>;
|
|
4
|
+
/**
|
|
5
|
+
* Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
|
|
6
|
+
*
|
|
7
|
+
* By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
|
|
8
|
+
* `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
|
|
9
|
+
*/
|
|
10
|
+
export declare function managementListOrders(payload: object): RequestOptionsFactory<any>;
|
|
11
|
+
/**
|
|
12
|
+
* Extends the duration of a pricing plan order by postponing the order's `endDate`. Postponing the end date of an order does not impact payments.
|
|
13
|
+
*
|
|
14
|
+
* New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
|
|
15
|
+
* Can't postpone an order with `status`: `PAUSED`.
|
|
16
|
+
*/
|
|
17
|
+
export declare function postponeEndDate(payload: object): RequestOptionsFactory<any>;
|
|
18
|
+
/**
|
|
19
|
+
* Cancels an existing order.
|
|
20
|
+
*
|
|
21
|
+
* For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
|
|
22
|
+
* For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
|
|
23
|
+
*
|
|
24
|
+
* #### Canceling during the free trial period.
|
|
25
|
+
*
|
|
26
|
+
* When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
|
|
27
|
+
* of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
|
|
28
|
+
* of the free trial period.
|
|
29
|
+
*
|
|
30
|
+
* When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
|
|
31
|
+
* `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
|
|
32
|
+
* immediately, even during the free trial period and the buyer won't be billed. Canceling at the
|
|
33
|
+
* `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
|
|
34
|
+
* Then, the subscription ends and the buyer is not billed.
|
|
35
|
+
*/
|
|
36
|
+
export declare function cancelOrder(payload: object): RequestOptionsFactory<any>;
|
|
37
|
+
/**
|
|
38
|
+
* Marks an offline order as paid.
|
|
39
|
+
* > __Note__: Marking separate payment cycles as paid is not yet supported. The entire order will be marked as paid. Subsequent offline payments do trigger events and emails, but are not registered as additional offline payments.
|
|
40
|
+
*
|
|
41
|
+
* Marking an offline order as paid causes the following changes:
|
|
42
|
+
* - The order's `lastPaymentStatus` changes to `"PAID"`.
|
|
43
|
+
* - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
|
|
44
|
+
*
|
|
45
|
+
* An error occurs if you attempt to:
|
|
46
|
+
* - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
|
|
47
|
+
* - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
|
|
48
|
+
*/
|
|
49
|
+
export declare function markAsPaid(payload: object): RequestOptionsFactory<any>;
|
|
50
|
+
/**
|
|
51
|
+
* Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
|
|
52
|
+
*
|
|
53
|
+
* Only orders with `status`: `ACTIVE` can be paused.
|
|
54
|
+
* For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
|
|
55
|
+
* Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
|
|
56
|
+
* The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
|
|
57
|
+
*
|
|
58
|
+
* To resume a paused order, call Resume Order.
|
|
59
|
+
*/
|
|
60
|
+
export declare function pauseOrder(payload: object): RequestOptionsFactory<any>;
|
|
61
|
+
/**
|
|
62
|
+
* Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
|
|
63
|
+
*
|
|
64
|
+
* Resuming an order causes the following changes:
|
|
65
|
+
* - The order status changes to `"ACTIVE"`.
|
|
66
|
+
* - The `pausePeriods` array is updated.
|
|
67
|
+
* - The `endDate` for the order is adjusted to include the pause period.
|
|
68
|
+
* - For orders with recurring payments, the payment schedule is restarted.
|
|
69
|
+
* - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
|
|
70
|
+
*
|
|
71
|
+
* To pause an order, call Pause Order.
|
|
72
|
+
*/
|
|
73
|
+
export declare function resumeOrder(payload: object): RequestOptionsFactory<any>;
|
|
2
74
|
/** Retrieves an order for the currently logged-in member by ID. */
|
|
3
75
|
export declare function memberGetOrder(payload: object): RequestOptionsFactory<any>;
|
|
4
76
|
/** Retrieves a list of up to 100 pricing plan orders for currently logged-in member. */
|
|
@@ -75,75 +147,3 @@ export declare function getOfflineOrderPreview(payload: object): RequestOptionsF
|
|
|
75
147
|
* generate a preview of a purchase for a specific buyer, call Get Offline Order Preview.
|
|
76
148
|
*/
|
|
77
149
|
export declare function getPricePreview(payload: object): RequestOptionsFactory<any>;
|
|
78
|
-
/** Retrieves an order by ID. */
|
|
79
|
-
export declare function managementGetOrder(payload: object): RequestOptionsFactory<any>;
|
|
80
|
-
/**
|
|
81
|
-
* Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
|
|
82
|
-
*
|
|
83
|
-
* By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
|
|
84
|
-
* `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
|
|
85
|
-
*/
|
|
86
|
-
export declare function managementListOrders(payload: object): RequestOptionsFactory<any>;
|
|
87
|
-
/**
|
|
88
|
-
* Extends the duration of a pricing plan order by postponing the order's `endDate`. Postponing the end date of an order does not impact payments.
|
|
89
|
-
*
|
|
90
|
-
* New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
|
|
91
|
-
* Can't postpone an order with `status`: `PAUSED`.
|
|
92
|
-
*/
|
|
93
|
-
export declare function postponeEndDate(payload: object): RequestOptionsFactory<any>;
|
|
94
|
-
/**
|
|
95
|
-
* Cancels an existing order.
|
|
96
|
-
*
|
|
97
|
-
* For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
|
|
98
|
-
* For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
|
|
99
|
-
*
|
|
100
|
-
* #### Canceling during the free trial period.
|
|
101
|
-
*
|
|
102
|
-
* When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
|
|
103
|
-
* of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
|
|
104
|
-
* of the free trial period.
|
|
105
|
-
*
|
|
106
|
-
* When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
|
|
107
|
-
* `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
|
|
108
|
-
* immediately, even during the free trial period and the buyer won't be billed. Canceling at the
|
|
109
|
-
* `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
|
|
110
|
-
* Then, the subscription ends and the buyer is not billed.
|
|
111
|
-
*/
|
|
112
|
-
export declare function cancelOrder(payload: object): RequestOptionsFactory<any>;
|
|
113
|
-
/**
|
|
114
|
-
* Marks an offline order as paid.
|
|
115
|
-
* > __Note__: Marking separate payment cycles as paid is not yet supported. The entire order will be marked as paid. Subsequent offline payments do trigger events and emails, but are not registered as additional offline payments.
|
|
116
|
-
*
|
|
117
|
-
* Marking an offline order as paid causes the following changes:
|
|
118
|
-
* - The order's `lastPaymentStatus` changes to `"PAID"`.
|
|
119
|
-
* - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
|
|
120
|
-
*
|
|
121
|
-
* An error occurs if you attempt to:
|
|
122
|
-
* - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
|
|
123
|
-
* - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
|
|
124
|
-
*/
|
|
125
|
-
export declare function markAsPaid(payload: object): RequestOptionsFactory<any>;
|
|
126
|
-
/**
|
|
127
|
-
* Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
|
|
128
|
-
*
|
|
129
|
-
* Only orders with `status`: `ACTIVE` can be paused.
|
|
130
|
-
* For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
|
|
131
|
-
* Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
|
|
132
|
-
* The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
|
|
133
|
-
*
|
|
134
|
-
* To resume a paused order, call Resume Order.
|
|
135
|
-
*/
|
|
136
|
-
export declare function pauseOrder(payload: object): RequestOptionsFactory<any>;
|
|
137
|
-
/**
|
|
138
|
-
* Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
|
|
139
|
-
*
|
|
140
|
-
* Resuming an order causes the following changes:
|
|
141
|
-
* - The order status changes to `"ACTIVE"`.
|
|
142
|
-
* - The `pausePeriods` array is updated.
|
|
143
|
-
* - The `endDate` for the order is adjusted to include the pause period.
|
|
144
|
-
* - For orders with recurring payments, the payment schedule is restarted.
|
|
145
|
-
* - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
|
|
146
|
-
*
|
|
147
|
-
* To pause an order, call Pause Order.
|
|
148
|
-
*/
|
|
149
|
-
export declare function resumeOrder(payload: object): RequestOptionsFactory<any>;
|