@wix/pricing-plans 1.0.0

package/build/cjs/src/pricing-plans-v2-order.universal.js

@@ -0,0 +1,962 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resumeOrder = exports.pauseOrder = exports.markAsPaid = exports.cancelOrder = exports.postponeEndDate = exports.managementListOrders = exports.managementGetOrder = exports.getPricePreview = exports.getOfflineOrderPreview = exports.createOfflineOrder = exports.requestCancellation = exports.memberListOrders = exports.memberGetOrder = exports.ReasonNotSuspendable = exports.SortOrder = exports.Set = exports.Status = exports.PaymentStatus = exports.CancellationEffectiveAt = exports.CancellationCause = exports.OrderStatus = exports.OrderMethod = exports.OrderType = exports.PeriodUnit = exports.__debug = void 0;
+const velo_1 = require("@wix/metro-runtime/velo");
+const ambassadorWixPricingPlansV2Order = __importStar(require("./pricing-plans-v2-order.http"));
+let __verbose = false;
+function __log(...args) {
+    __verbose && console.log(...args);
+}
+function __inspect(obj) {
+    return obj;
+}
+exports.__debug = {
+    verboseLogging: {
+        on: () => (__verbose = true),
+        off: () => (__verbose = false),
+    },
+};
+const _toVeloEntity = '$';
+const _fromVeloEntity = '$';
+var PeriodUnit;
+(function (PeriodUnit) {
+    PeriodUnit["UNDEFINED"] = "UNDEFINED";
+    PeriodUnit["DAY"] = "DAY";
+    PeriodUnit["WEEK"] = "WEEK";
+    PeriodUnit["MONTH"] = "MONTH";
+    PeriodUnit["YEAR"] = "YEAR";
+})(PeriodUnit = exports.PeriodUnit || (exports.PeriodUnit = {}));
+var OrderType;
+(function (OrderType) {
+    OrderType["UNDEFINED"] = "UNDEFINED";
+    /** Payments made by the buyer */
+    OrderType["ONLINE"] = "ONLINE";
+    /** Payments managed manually by the site owner */
+    OrderType["OFFLINE"] = "OFFLINE";
+})(OrderType = exports.OrderType || (exports.OrderType = {}));
+var OrderMethod;
+(function (OrderMethod) {
+    OrderMethod["UNKNOWN"] = "UNKNOWN";
+    /** Mail Order / Telephone Order transaction */
+    OrderMethod["MOTO"] = "MOTO";
+    /** Point of Sale transaction */
+    OrderMethod["POS"] = "POS";
+})(OrderMethod = exports.OrderMethod || (exports.OrderMethod = {}));
+var OrderStatus;
+(function (OrderStatus) {
+    /** Order status undefined */
+    OrderStatus["UNDEFINED"] = "UNDEFINED";
+    /** Order created, but hasn't been paid for yet. Filtered out in ListOrders response by default. */
+    OrderStatus["DRAFT"] = "DRAFT";
+    /** Order has been paid for, but the start date is in the future */
+    OrderStatus["PENDING"] = "PENDING";
+    /** Order is active */
+    OrderStatus["ACTIVE"] = "ACTIVE";
+    /** Order is paused until site owner resumes it */
+    OrderStatus["PAUSED"] = "PAUSED";
+    /** Order has ended */
+    OrderStatus["ENDED"] = "ENDED";
+    /** Order has been canceled */
+    OrderStatus["CANCELED"] = "CANCELED";
+})(OrderStatus = exports.OrderStatus || (exports.OrderStatus = {}));
+var CancellationCause;
+(function (CancellationCause) {
+    /** Cancellation initiator undefined */
+    CancellationCause["UNDEFINED"] = "UNDEFINED";
+    /** Order was canceled by site owner (default if canceled by user or service identity) */
+    CancellationCause["OWNER_ACTION"] = "OWNER_ACTION";
+    /** Order was canceled by member (default if canceled by member identity) */
+    CancellationCause["MEMBER_ACTION"] = "MEMBER_ACTION";
+    /** Order was canceled because of payment failure */
+    CancellationCause["PAYMENT_FAILURE"] = "PAYMENT_FAILURE";
+    /** Order was canceled because of payment setup failure */
+    CancellationCause["PAYMENT_SETUP_FAILURE"] = "PAYMENT_SETUP_FAILURE";
+    /** Order was cancelled because of an unknown reason. It's not possible to know with certain payment providers (e.g. paypal) */
+    CancellationCause["UNKNOWN"] = "UNKNOWN";
+})(CancellationCause = exports.CancellationCause || (exports.CancellationCause = {}));
+var CancellationEffectiveAt;
+(function (CancellationEffectiveAt) {
+    /** Cancellation time undefined */
+    CancellationEffectiveAt["UNDEFINED"] = "UNDEFINED";
+    /** Will cancel the order now, i.e. update validUntil to the current date */
+    CancellationEffectiveAt["IMMEDIATELY"] = "IMMEDIATELY";
+    /** Will cancel the order at the date when next payment should have been made */
+    CancellationEffectiveAt["NEXT_PAYMENT_DATE"] = "NEXT_PAYMENT_DATE";
+})(CancellationEffectiveAt = exports.CancellationEffectiveAt || (exports.CancellationEffectiveAt = {}));
+var PaymentStatus;
+(function (PaymentStatus) {
+    /** Payment status undefined */
+    PaymentStatus["UNDEFINED"] = "UNDEFINED";
+    /** Payment has been paid */
+    PaymentStatus["PAID"] = "PAID";
+    /** Payment has been refunded */
+    PaymentStatus["REFUNDED"] = "REFUNDED";
+    /** Recurring payment has failed */
+    PaymentStatus["FAILED"] = "FAILED";
+    /** Payment has not been paid */
+    PaymentStatus["UNPAID"] = "UNPAID";
+    /** Billing has been initialized, but actual charge is yet to be made. Can happen for free trial and PayPal */
+    PaymentStatus["PENDING"] = "PENDING";
+    /** Used in cases where the plan is free */
+    PaymentStatus["NOT_APPLICABLE"] = "NOT_APPLICABLE";
+})(PaymentStatus = exports.PaymentStatus || (exports.PaymentStatus = {}));
+var Status;
+(function (Status) {
+    Status["UNDEFINED"] = "UNDEFINED";
+    /** Order suspension is active */
+    Status["ACTIVE"] = "ACTIVE";
+    /** Order suspension has ended */
+    Status["ENDED"] = "ENDED";
+})(Status = exports.Status || (exports.Status = {}));
+var Set;
+(function (Set) {
+    /** Same behavior as BASIC */
+    Set["UNKNOWN_SET"] = "UNKNOWN_SET";
+    /**
+     * Returns fields of the entity that are available in the database.
+     * By default a field is available in the database unless explicitly specified in the documentation
+     */
+    Set["BASIC"] = "BASIC";
+    /**
+     * Returns all fields in the entity.
+     * This might make additional calls to gather the full entity
+     */
+    Set["FULL"] = "FULL";
+})(Set = exports.Set || (exports.Set = {}));
+var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder = exports.SortOrder || (exports.SortOrder = {}));
+var ReasonNotSuspendable;
+(function (ReasonNotSuspendable) {
+    /** Reason unknown */
+    ReasonNotSuspendable["UNDEFINED"] = "UNDEFINED";
+    /** Saved in the database but is awaiting payment. Non-active orders cannot be suspended */
+    ReasonNotSuspendable["PENDING"] = "PENDING";
+    /** Trial orders cannot be suspended */
+    ReasonNotSuspendable["TRIAL"] = "TRIAL";
+    /** Canceled orders cannot be suspended */
+    ReasonNotSuspendable["CANCELED"] = "CANCELED";
+    /** Ended orders cannot be suspended */
+    ReasonNotSuspendable["ENDED"] = "ENDED";
+    /** Paid for orders with future start dates cannot be suspended */
+    ReasonNotSuspendable["NOT_STARTED"] = "NOT_STARTED";
+    /** Order is already suspended */
+    ReasonNotSuspendable["ALREADY_SUSPENDED"] = "ALREADY_SUSPENDED";
+    /** Orders based on recurring payments using older Stripe versions cannot be suspended */
+    ReasonNotSuspendable["OLD_STRIPE"] = "OLD_STRIPE";
+})(ReasonNotSuspendable = exports.ReasonNotSuspendable || (exports.ReasonNotSuspendable = {}));
+const _cancelOrderRequest = {};
+const _cancelOrderResponse = {};
+const _createOfflineOrderRequest = {};
+const _createOfflineOrderResponse = {};
+const _getOfflineOrderPreviewRequest = {};
+const _getOfflineOrderPreviewResponse = {};
+const _getOrderRequest = {};
+const _getOrderResponse = {};
+const _getPricePreviewRequest = {};
+const _getPricePreviewResponse = {};
+const _listOrdersRequest = {};
+const _listOrdersResponse = {};
+const _markAsPaidRequest = {};
+const _markAsPaidResponse = {};
+const _memberGetOrderRequest = {};
+const _memberGetOrderResponse = {};
+const _memberListOrdersRequest = {};
+const _memberListOrdersResponse = {};
+const _pauseOrderRequest = {};
+const _pauseOrderResponse = {};
+const _postponeEndDateRequest = {};
+const _postponeEndDateResponse = {};
+const _requestCancellationRequest = {};
+const _requestCancellationResponse = {};
+const _resumeOrderRequest = {};
+const _resumeOrderResponse = {};
+/**
+ * Retrieves an order by ID.
+ * @param _id - Order ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+function memberGetOrder(_id, options) {
+    var _a, _b, _c;
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = { id: '$[0]', fieldSet: '$[1].fieldSet' };
+        const responseTransformation = '$';
+        // @ts-ignore
+        const { httpClient, sideEffects } = arguments[2];
+        const { toAmbassadorRequest } = velo_1.serializer({
+            rootSchema: _memberGetOrderRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = velo_1.serializer({
+            rootSchema: _memberGetOrderResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [...['order']],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([_id, options]);
+        const reqOpts = ambassadorWixPricingPlansV2Order.memberGetOrder(payload);
+        __log(`"GetOrder" sending request with: ${__inspect(reqOpts)}`);
+        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+        try {
+            const result = yield httpClient.request(reqOpts);
+            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+            return fromJSON(result.data);
+        }
+        catch (err) {
+            const transformedError = velo_1.transformError(err, requestTransformation, [
+                '_id',
+                'options',
+            ]);
+            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+            throw transformedError;
+        }
+    });
+}
+exports.memberGetOrder = memberGetOrder;
+/**
+ * Returns orders for currently logged in member.
+ * @public
+ * @documentationMaturity preview
+ */
+function memberListOrders(options) {
+    var _a, _b, _c;
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = {
+            planIds: '$[0].planIds',
+            autoRenewCanceled: '$[0].autoRenewCanceled',
+            orderStatuses: '$[0].orderStatuses',
+            paymentStatuses: '$[0].paymentStatuses',
+            limit: '$[0].limit',
+            offset: '$[0].offset',
+            sorting: '$[0].sorting',
+        };
+        const responseTransformation = '$';
+        // @ts-ignore
+        const { httpClient, sideEffects } = arguments[1];
+        const { toAmbassadorRequest } = velo_1.serializer({
+            rootSchema: _memberListOrdersRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = velo_1.serializer({
+            rootSchema: _memberListOrdersResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [...['Array#orders']],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([options]);
+        const reqOpts = ambassadorWixPricingPlansV2Order.memberListOrders(payload);
+        __log(`"ListOrders" sending request with: ${__inspect(reqOpts)}`);
+        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+        try {
+            const result = yield httpClient.request(reqOpts);
+            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+            return fromJSON(result.data);
+        }
+        catch (err) {
+            const transformedError = velo_1.transformError(err, requestTransformation, [
+                'options',
+            ]);
+            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+            throw transformedError;
+        }
+    });
+}
+exports.memberListOrders = memberListOrders;
+/**
+ * Cancels an order. Recurring orders can be canceled either immediately or at the next payment date.
+ * One time orders can only be canceled immediately.
+ * @param _id - Order ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+function requestCancellation(_id, options) {
+    var _a, _b, _c;
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = { id: '$[0]', effectiveAt: '$[1].effectiveAt' };
+        const responseTransformation = '$';
+        // @ts-ignore
+        const { httpClient, sideEffects } = arguments[2];
+        const { toAmbassadorRequest } = velo_1.serializer({
+            rootSchema: _requestCancellationRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = velo_1.serializer({
+            rootSchema: _requestCancellationResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([_id, options]);
+        const reqOpts = ambassadorWixPricingPlansV2Order.requestCancellation(payload);
+        __log(`"RequestCancellation" sending request with: ${__inspect(reqOpts)}`);
+        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+        try {
+            const result = yield httpClient.request(reqOpts);
+            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+            return fromJSON(result.data);
+        }
+        catch (err) {
+            const transformedError = velo_1.transformError(err, requestTransformation, [
+                '_id',
+                'options',
+            ]);
+            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+            throw transformedError;
+        }
+    });
+}
+exports.requestCancellation = requestCancellation;
+/**
+ * Creates an order for a buyer who purchased the plan with an offline transaction.
+ *
+ * An offline order is handled off of the Wix site and is marked as `offline` in `type`. If a pricing plan
+ * has a limit on the amount of purchases per buyer, that limit is ignored for offline orders.
+ * Tax is only applied if the site [has it configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection).
+ *
+ * Handle payment for an offline order in 1 of 2 ways:
+ * + When creating the order, select `true` in the `paid` request parameter.
+ * + After creation, use [Mark As Paid to mark the order as paid](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/mark-as-paid).
+ * @param planId - ID of the plan being ordered. See [Plans for more information about plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans).
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.memberId
+ * @requiredField planId
+ */
+function createOfflineOrder(planId, options) {
+    var _a, _b, _c;
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = {
+            planId: '$[0]',
+            memberId: '$[1].memberId',
+            startDate: '$[1].startDate',
+            paid: '$[1].paid',
+            couponCode: '$[1].couponCode',
+            submissionId: '$[1].submissionId',
+        };
+        const responseTransformation = '$';
+        // @ts-ignore
+        const { httpClient, sideEffects } = arguments[2];
+        const { toAmbassadorRequest } = velo_1.serializer({
+            rootSchema: _createOfflineOrderRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = velo_1.serializer({
+            rootSchema: _createOfflineOrderResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [...['order']],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([planId, options]);
+        const reqOpts = ambassadorWixPricingPlansV2Order.createOfflineOrder(payload);
+        __log(`"CreateOfflineOrder" sending request with: ${__inspect(reqOpts)}`);
+        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+        try {
+            const result = yield httpClient.request(reqOpts);
+            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+            return fromJSON(result.data);
+        }
+        catch (err) {
+            const transformedError = velo_1.transformError(err, requestTransformation, [
+                'planId',
+                'options',
+            ]);
+            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+            throw transformedError;
+        }
+    });
+}
+exports.createOfflineOrder = createOfflineOrder;
+/**
+ * Performs a dry run of a purchase and provides an order preview.
+ *
+ * The preview uses the same logic as purchasing a plan, but the preview is not saved. Because an order is not actually
+ * created, the preview order's `orderId` and `subscriptionId` are displayed as a string of multiple zero characters
+ * (`000000-0000`). Tax is only calculated if the site [has it configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection).
+ * <br>
+ * If a pricing plan has a limit on the amount of purchases per buyer, that limit is not considered for generating the preview.
+ * But, if that limit has been reached and this order would then exceed the amount of purchases permitted for this buyer, then
+ * `purchaseLimitExceeded` will return as `true`.
+ *
+ * To get a general price preview for a plan that's not buyer-specific, use [Get Price Preview](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/get-price-preview).
+ * @param planId - ID of the plan of the previewed order. See [Plans for more information about plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans).
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.memberId
+ * @requiredField planId
+ */
+function getOfflineOrderPreview(planId, options) {
+    var _a, _b, _c;
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = {
+            planId: '$[0]',
+            memberId: '$[1].memberId',
+            startDate: '$[1].startDate',
+            couponCode: '$[1].couponCode',
+        };
+        const responseTransformation = '$';
+        // @ts-ignore
+        const { httpClient, sideEffects } = arguments[2];
+        const { toAmbassadorRequest } = velo_1.serializer({
+            rootSchema: _getOfflineOrderPreviewRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = velo_1.serializer({
+            rootSchema: _getOfflineOrderPreviewResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [...['order']],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([planId, options]);
+        const reqOpts = ambassadorWixPricingPlansV2Order.getOfflineOrderPreview(payload);
+        __log(`"GetOfflineOrderPreview" sending request with: ${__inspect(reqOpts)}`);
+        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+        try {
+            const result = yield httpClient.request(reqOpts);
+            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+            return fromJSON(result.data);
+        }
+        catch (err) {
+            const transformedError = velo_1.transformError(err, requestTransformation, [
+                'planId',
+                'options',
+            ]);
+            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+            throw transformedError;
+        }
+    });
+}
+exports.getOfflineOrderPreview = getOfflineOrderPreview;
+/**
+ * Retrieves a plan's pricing.
+ *
+ * The price preview uses the same logic as purchasing a plan, but the preview is not saved. Tax is only applied if
+ * the site [has it configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection). The price is returned
+ * in the [pricing model](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/introduction#wix-pricing-plans_pricing-plans_introduction_pricing-models) format used for orders.
+ *
+ * Buyers do not have to be logged in to preview the price, as such, the details returned are not buyer-specific. To
+ * generate a preview of a purchase for a specific buyer, use [Get Offline Order Preview](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/get-offline-order-preview).
+ * @param planId - ID of plan to preview.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField planId
+ */
+function getPricePreview(planId, options) {
+    var _a, _b, _c;
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = {
+            planId: '$[0]',
+            couponCode: '$[1].couponCode',
+        };
+        const responseTransformation = '$';
+        // @ts-ignore
+        const { httpClient, sideEffects } = arguments[2];
+        const { toAmbassadorRequest } = velo_1.serializer({
+            rootSchema: _getPricePreviewRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = velo_1.serializer({
+            rootSchema: _getPricePreviewResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([planId, options]);
+        const reqOpts = ambassadorWixPricingPlansV2Order.getPricePreview(payload);
+        __log(`"GetPricePreview" sending request with: ${__inspect(reqOpts)}`);
+        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+        try {
+            const result = yield httpClient.request(reqOpts);
+            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+            return fromJSON(result.data);
+        }
+        catch (err) {
+            const transformedError = velo_1.transformError(err, requestTransformation, [
+                'planId',
+                'options',
+            ]);
+            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+            throw transformedError;
+        }
+    });
+}
+exports.getPricePreview = getPricePreview;
+/**
+ * Retrieves an order by ID.
+ * @param _id - Order ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+function managementGetOrder(_id, options) {
+    var _a, _b, _c;
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = { id: '$[0]', fieldSet: '$[1].fieldSet' };
+        const responseTransformation = '$';
+        // @ts-ignore
+        const { httpClient, sideEffects } = arguments[2];
+        const { toAmbassadorRequest } = velo_1.serializer({
+            rootSchema: _getOrderRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = velo_1.serializer({
+            rootSchema: _getOrderResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [...['order']],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([_id, options]);
+        const reqOpts = ambassadorWixPricingPlansV2Order.managementGetOrder(payload);
+        __log(`"GetOrder" sending request with: ${__inspect(reqOpts)}`);
+        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+        try {
+            const result = yield httpClient.request(reqOpts);
+            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+            return fromJSON(result.data);
+        }
+        catch (err) {
+            const transformedError = velo_1.transformError(err, requestTransformation, [
+                '_id',
+                'options',
+            ]);
+            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+            throw transformedError;
+        }
+    });
+}
+exports.managementGetOrder = managementGetOrder;
+/**
+ * Retrieves a list of orders and details, given the provided sorting and filtering.
+ *
+ * By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
+ * `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
+ * @public
+ * @documentationMaturity preview
+ */
+function managementListOrders(options) {
+    var _a, _b, _c;
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = {
+            buyerIds: '$[0].buyerIds',
+            planIds: '$[0].planIds',
+            autoRenewCanceled: '$[0].autoRenewCanceled',
+            orderStatuses: '$[0].orderStatuses',
+            paymentStatuses: '$[0].paymentStatuses',
+            limit: '$[0].limit',
+            offset: '$[0].offset',
+            sorting: '$[0].sorting',
+        };
+        const responseTransformation = '$';
+        // @ts-ignore
+        const { httpClient, sideEffects } = arguments[1];
+        const { toAmbassadorRequest } = velo_1.serializer({
+            rootSchema: _listOrdersRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = velo_1.serializer({
+            rootSchema: _listOrdersResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [...['Array#orders']],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([options]);
+        const reqOpts = ambassadorWixPricingPlansV2Order.managementListOrders(payload);
+        __log(`"ListOrders" sending request with: ${__inspect(reqOpts)}`);
+        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+        try {
+            const result = yield httpClient.request(reqOpts);
+            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+            return fromJSON(result.data);
+        }
+        catch (err) {
+            const transformedError = velo_1.transformError(err, requestTransformation, [
+                'options',
+            ]);
+            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+            throw transformedError;
+        }
+    });
+}
+exports.managementListOrders = managementListOrders;
+/**
+ * Extends the duration of a pricing plan order by postponing the order's `endDate`.
+ *
+ * New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
+ * Can't postpone an order while it is [`PAUSED`](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/pause-order).
+ * @param _id - Order ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+function postponeEndDate(_id, options) {
+    var _a, _b, _c;
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = { id: '$[0]', endDate: '$[1].endDate' };
+        const responseTransformation = '$';
+        // @ts-ignore
+        const { httpClient, sideEffects } = arguments[2];
+        const { toAmbassadorRequest } = velo_1.serializer({
+            rootSchema: _postponeEndDateRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = velo_1.serializer({
+            rootSchema: _postponeEndDateResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([_id, options]);
+        const reqOpts = ambassadorWixPricingPlansV2Order.postponeEndDate(payload);
+        __log(`"PostponeEndDate" sending request with: ${__inspect(reqOpts)}`);
+        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+        try {
+            const result = yield httpClient.request(reqOpts);
+            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+            return fromJSON(result.data);
+        }
+        catch (err) {
+            const transformedError = velo_1.transformError(err, requestTransformation, [
+                '_id',
+                'options',
+            ]);
+            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+            throw transformedError;
+        }
+    });
+}
+exports.postponeEndDate = postponeEndDate;
+/**
+ * Cancels an existing order.
+ *
+ * For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
+ * For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
+ *
+ * #### 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 will not be billed. The buyer may continue using the benefits until the end
+ * of the free trial period.
+ *
+ * When a site owner cancels an ordered plan during the free trial period, they choose to apply the cancellation
+ * `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
+ * immediately, even during the free trial period and the buyer won't be billed. Canceling at the
+ * `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
+ * Then, the subscription ends and the buyer is not billed.
+ * @param _id - Order ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+function cancelOrder(_id, options) {
+    var _a, _b, _c;
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = { id: '$[0]', effectiveAt: '$[1].effectiveAt' };
+        const responseTransformation = '$';
+        // @ts-ignore
+        const { httpClient, sideEffects } = arguments[2];
+        const { toAmbassadorRequest } = velo_1.serializer({
+            rootSchema: _cancelOrderRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = velo_1.serializer({
+            rootSchema: _cancelOrderResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([_id, options]);
+        const reqOpts = ambassadorWixPricingPlansV2Order.cancelOrder(payload);
+        __log(`"CancelOrder" sending request with: ${__inspect(reqOpts)}`);
+        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+        try {
+            const result = yield httpClient.request(reqOpts);
+            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+            return fromJSON(result.data);
+        }
+        catch (err) {
+            const transformedError = velo_1.transformError(err, requestTransformation, [
+                '_id',
+                'options',
+            ]);
+            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+            throw transformedError;
+        }
+    });
+}
+exports.cancelOrder = cancelOrder;
+/**
+ * Marks an offline order as paid.
+ * > __Note__: Marking separate payment cycles as paid is not yet supported. The entire order will be marked as paid.
+ * @param _id - Order ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+function markAsPaid(_id) {
+    var _a, _b, _c;
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = { id: '$[0]' };
+        const responseTransformation = '$';
+        // @ts-ignore
+        const { httpClient, sideEffects } = arguments[1];
+        const { toAmbassadorRequest } = velo_1.serializer({
+            rootSchema: _markAsPaidRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = velo_1.serializer({
+            rootSchema: _markAsPaidResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([_id]);
+        const reqOpts = ambassadorWixPricingPlansV2Order.markAsPaid(payload);
+        __log(`"MarkAsPaid" sending request with: ${__inspect(reqOpts)}`);
+        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+        try {
+            const result = yield httpClient.request(reqOpts);
+            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+            return fromJSON(result.data);
+        }
+        catch (err) {
+            const transformedError = velo_1.transformError(err, requestTransformation, [
+                '_id',
+            ]);
+            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+            throw transformedError;
+        }
+    });
+}
+exports.markAsPaid = markAsPaid;
+/**
+ * Pauses an order.
+ *
+ * For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
+ * Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`. Can only pause orders with an `ACTIVE` status.
+ *
+ * Use [Resume Order to resume a paused order](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/resume-order/).
+ * @param _id - Order ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+function pauseOrder(_id) {
+    var _a, _b, _c;
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = { id: '$[0]' };
+        const responseTransformation = '$';
+        // @ts-ignore
+        const { httpClient, sideEffects } = arguments[1];
+        const { toAmbassadorRequest } = velo_1.serializer({
+            rootSchema: _pauseOrderRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = velo_1.serializer({
+            rootSchema: _pauseOrderResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([_id]);
+        const reqOpts = ambassadorWixPricingPlansV2Order.pauseOrder(payload);
+        __log(`"PauseOrder" sending request with: ${__inspect(reqOpts)}`);
+        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+        try {
+            const result = yield httpClient.request(reqOpts);
+            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+            return fromJSON(result.data);
+        }
+        catch (err) {
+            const transformedError = velo_1.transformError(err, requestTransformation, [
+                '_id',
+            ]);
+            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+            throw transformedError;
+        }
+    });
+}
+exports.pauseOrder = pauseOrder;
+/**
+ * Resumes a paused order.
+ *
+ * Updates `endDate` by adding the time the plan was paused.
+ * For orders with recurring payments, it also restarts the payment schedule.
+ * Use [Pause Order to pause an order](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/pause-order/).
+ * @param _id - Order ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ */
+function resumeOrder(_id) {
+    var _a, _b, _c;
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = { id: '$[0]' };
+        const responseTransformation = '$';
+        // @ts-ignore
+        const { httpClient, sideEffects } = arguments[1];
+        const { toAmbassadorRequest } = velo_1.serializer({
+            rootSchema: _resumeOrderRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = velo_1.serializer({
+            rootSchema: _resumeOrderResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([_id]);
+        const reqOpts = ambassadorWixPricingPlansV2Order.resumeOrder(payload);
+        __log(`"ResumeOrder" sending request with: ${__inspect(reqOpts)}`);
+        (_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
+        try {
+            const result = yield httpClient.request(reqOpts);
+            (_b = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSuccess) === null || _b === void 0 ? void 0 : _b.call(sideEffects, result);
+            return fromJSON(result.data);
+        }
+        catch (err) {
+            const transformedError = velo_1.transformError(err, requestTransformation, [
+                '_id',
+            ]);
+            (_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
+            throw transformedError;
+        }
+    });
+}
+exports.resumeOrder = resumeOrder;
+//# sourceMappingURL=pricing-plans-v2-order.universal.js.map