@wix/auto_sdk_pricing-plans_orders 1.0.63 → 1.0.65
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +21 -7
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/{pricing-plans-v2-order-orders.universal-BoSpvZn2.d.ts → index.typings.d.ts} +833 -1
- package/build/cjs/index.typings.js +1349 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +2 -1
- package/build/es/index.d.mts +21 -7
- package/build/es/index.mjs.map +1 -1
- package/build/es/{pricing-plans-v2-order-orders.universal-BoSpvZn2.d.mts → index.typings.d.mts} +833 -1
- package/build/es/index.typings.mjs +1299 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/meta.d.mts +2 -1
- package/build/internal/cjs/index.d.ts +21 -7
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/{pricing-plans-v2-order-orders.universal-C4vOetLA.d.ts → index.typings.d.ts} +833 -1
- package/build/internal/cjs/index.typings.js +1349 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +2 -1
- package/build/internal/es/index.d.mts +21 -7
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/{pricing-plans-v2-order-orders.universal-C4vOetLA.d.mts → index.typings.d.mts} +833 -1
- package/build/internal/es/index.typings.mjs +1299 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +2 -1
- package/package.json +3 -3
package/build/cjs/{pricing-plans-v2-order-orders.universal-BoSpvZn2.d.ts → index.typings.d.ts}
RENAMED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
|
|
1
3
|
/**
|
|
2
4
|
* An order object includes all of the details related to the purchase of a Pricing Plan.
|
|
3
5
|
* You can manage existing orders, create offline orders, and preview orders not yet purchased.
|
|
@@ -1465,6 +1467,293 @@ interface SetSubmissionResponse {
|
|
|
1465
1467
|
/** Order with submission id */
|
|
1466
1468
|
order?: Order;
|
|
1467
1469
|
}
|
|
1470
|
+
type CreateOnlineOrderApplicationErrors = {
|
|
1471
|
+
code?: 'MEMBER_REQUIRED';
|
|
1472
|
+
description?: string;
|
|
1473
|
+
data?: Record<string, any>;
|
|
1474
|
+
} | {
|
|
1475
|
+
code?: 'archived_plan';
|
|
1476
|
+
description?: string;
|
|
1477
|
+
data?: Record<string, any>;
|
|
1478
|
+
} | {
|
|
1479
|
+
code?: 'member_not_found';
|
|
1480
|
+
description?: string;
|
|
1481
|
+
data?: Record<string, any>;
|
|
1482
|
+
} | {
|
|
1483
|
+
code?: 'purchases_limit_reached';
|
|
1484
|
+
description?: string;
|
|
1485
|
+
data?: Record<string, any>;
|
|
1486
|
+
} | {
|
|
1487
|
+
code?: 'buyer_can_not_pick_future_start_date';
|
|
1488
|
+
description?: string;
|
|
1489
|
+
data?: Record<string, any>;
|
|
1490
|
+
} | {
|
|
1491
|
+
code?: 'invalid_start_date';
|
|
1492
|
+
description?: string;
|
|
1493
|
+
data?: Record<string, any>;
|
|
1494
|
+
} | {
|
|
1495
|
+
code?: 'accept_payment_feature_missing';
|
|
1496
|
+
description?: string;
|
|
1497
|
+
data?: Record<string, any>;
|
|
1498
|
+
} | {
|
|
1499
|
+
code?: 'meta_site_id_missing';
|
|
1500
|
+
description?: string;
|
|
1501
|
+
data?: Record<string, any>;
|
|
1502
|
+
} | {
|
|
1503
|
+
code?: 'ERROR_COUPON_IS_DISABLED';
|
|
1504
|
+
description?: string;
|
|
1505
|
+
data?: CouponsError;
|
|
1506
|
+
} | {
|
|
1507
|
+
code?: 'ERROR_COUPON_USAGE_EXCEEDED';
|
|
1508
|
+
description?: string;
|
|
1509
|
+
data?: CouponsError;
|
|
1510
|
+
} | {
|
|
1511
|
+
code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
|
|
1512
|
+
description?: string;
|
|
1513
|
+
data?: CouponsError;
|
|
1514
|
+
} | {
|
|
1515
|
+
code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
|
|
1516
|
+
description?: string;
|
|
1517
|
+
data?: CouponsError;
|
|
1518
|
+
} | {
|
|
1519
|
+
code?: 'ERROR_COUPON_HAS_EXPIRED';
|
|
1520
|
+
description?: string;
|
|
1521
|
+
data?: CouponsError;
|
|
1522
|
+
} | {
|
|
1523
|
+
code?: 'ERROR_COUPON_DOES_NOT_EXIST';
|
|
1524
|
+
description?: string;
|
|
1525
|
+
data?: CouponsError;
|
|
1526
|
+
} | {
|
|
1527
|
+
code?: 'ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN';
|
|
1528
|
+
description?: string;
|
|
1529
|
+
data?: CouponsError;
|
|
1530
|
+
} | {
|
|
1531
|
+
code?: 'ERROR_INVALID_SUBTOTAL';
|
|
1532
|
+
description?: string;
|
|
1533
|
+
data?: CouponsError;
|
|
1534
|
+
} | {
|
|
1535
|
+
code?: 'undefined_not_allowed';
|
|
1536
|
+
description?: string;
|
|
1537
|
+
data?: Record<string, any>;
|
|
1538
|
+
} | {
|
|
1539
|
+
code?: 'MISSING_BUSINESS_ADDRESS_COUNTRY';
|
|
1540
|
+
description?: string;
|
|
1541
|
+
data?: Record<string, any>;
|
|
1542
|
+
} | {
|
|
1543
|
+
code?: 'MISSING_BUSINESS_ADDRESS_STATE';
|
|
1544
|
+
description?: string;
|
|
1545
|
+
data?: Record<string, any>;
|
|
1546
|
+
};
|
|
1547
|
+
type CreateOnlineOrderValidationErrors = {
|
|
1548
|
+
ruleName?: 'UNKNOWN_ORDER_METHOD';
|
|
1549
|
+
} | {
|
|
1550
|
+
ruleName?: 'RECURRING_POS_UNSUPPORTED';
|
|
1551
|
+
} | {
|
|
1552
|
+
ruleName?: 'invalid_sort_field';
|
|
1553
|
+
};
|
|
1554
|
+
type CreateOfflineOrderApplicationErrors = {
|
|
1555
|
+
code?: 'PRICING_PLANS_NOT_INSTALLED';
|
|
1556
|
+
description?: string;
|
|
1557
|
+
data?: Record<string, any>;
|
|
1558
|
+
} | {
|
|
1559
|
+
code?: 'meta_site_id_missing';
|
|
1560
|
+
description?: string;
|
|
1561
|
+
data?: Record<string, any>;
|
|
1562
|
+
} | {
|
|
1563
|
+
code?: 'ERROR_COUPON_IS_DISABLED';
|
|
1564
|
+
description?: string;
|
|
1565
|
+
data?: CouponsError;
|
|
1566
|
+
} | {
|
|
1567
|
+
code?: 'ERROR_COUPON_USAGE_EXCEEDED';
|
|
1568
|
+
description?: string;
|
|
1569
|
+
data?: CouponsError;
|
|
1570
|
+
} | {
|
|
1571
|
+
code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
|
|
1572
|
+
description?: string;
|
|
1573
|
+
data?: CouponsError;
|
|
1574
|
+
} | {
|
|
1575
|
+
code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
|
|
1576
|
+
description?: string;
|
|
1577
|
+
data?: CouponsError;
|
|
1578
|
+
} | {
|
|
1579
|
+
code?: 'ERROR_COUPON_HAS_EXPIRED';
|
|
1580
|
+
description?: string;
|
|
1581
|
+
data?: CouponsError;
|
|
1582
|
+
} | {
|
|
1583
|
+
code?: 'ERROR_COUPON_DOES_NOT_EXIST';
|
|
1584
|
+
description?: string;
|
|
1585
|
+
data?: CouponsError;
|
|
1586
|
+
} | {
|
|
1587
|
+
code?: 'ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN';
|
|
1588
|
+
description?: string;
|
|
1589
|
+
data?: CouponsError;
|
|
1590
|
+
} | {
|
|
1591
|
+
code?: 'ERROR_INVALID_SUBTOTAL';
|
|
1592
|
+
description?: string;
|
|
1593
|
+
data?: CouponsError;
|
|
1594
|
+
} | {
|
|
1595
|
+
code?: 'undefined_not_allowed';
|
|
1596
|
+
description?: string;
|
|
1597
|
+
data?: Record<string, any>;
|
|
1598
|
+
} | {
|
|
1599
|
+
code?: 'MISSING_BUSINESS_ADDRESS_COUNTRY';
|
|
1600
|
+
description?: string;
|
|
1601
|
+
data?: Record<string, any>;
|
|
1602
|
+
} | {
|
|
1603
|
+
code?: 'MISSING_BUSINESS_ADDRESS_STATE';
|
|
1604
|
+
description?: string;
|
|
1605
|
+
data?: Record<string, any>;
|
|
1606
|
+
};
|
|
1607
|
+
type CreateOfflineOrderValidationErrors = {
|
|
1608
|
+
ruleName?: 'MEMBER_DOESNT_EXIST';
|
|
1609
|
+
} | {
|
|
1610
|
+
ruleName?: 'invalid_sort_field';
|
|
1611
|
+
};
|
|
1612
|
+
type GetOnlineOrderPreviewApplicationErrors = {
|
|
1613
|
+
code?: 'PRICING_PLANS_NOT_INSTALLED';
|
|
1614
|
+
description?: string;
|
|
1615
|
+
data?: Record<string, any>;
|
|
1616
|
+
} | {
|
|
1617
|
+
code?: 'ERROR_COUPON_IS_DISABLED';
|
|
1618
|
+
description?: string;
|
|
1619
|
+
data?: CouponsError;
|
|
1620
|
+
} | {
|
|
1621
|
+
code?: 'ERROR_COUPON_USAGE_EXCEEDED';
|
|
1622
|
+
description?: string;
|
|
1623
|
+
data?: CouponsError;
|
|
1624
|
+
} | {
|
|
1625
|
+
code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
|
|
1626
|
+
description?: string;
|
|
1627
|
+
data?: CouponsError;
|
|
1628
|
+
} | {
|
|
1629
|
+
code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
|
|
1630
|
+
description?: string;
|
|
1631
|
+
data?: CouponsError;
|
|
1632
|
+
} | {
|
|
1633
|
+
code?: 'ERROR_COUPON_HAS_EXPIRED';
|
|
1634
|
+
description?: string;
|
|
1635
|
+
data?: CouponsError;
|
|
1636
|
+
} | {
|
|
1637
|
+
code?: 'ERROR_COUPON_DOES_NOT_EXIST';
|
|
1638
|
+
description?: string;
|
|
1639
|
+
data?: CouponsError;
|
|
1640
|
+
} | {
|
|
1641
|
+
code?: 'ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN';
|
|
1642
|
+
description?: string;
|
|
1643
|
+
data?: CouponsError;
|
|
1644
|
+
} | {
|
|
1645
|
+
code?: 'ERROR_INVALID_SUBTOTAL';
|
|
1646
|
+
description?: string;
|
|
1647
|
+
data?: CouponsError;
|
|
1648
|
+
} | {
|
|
1649
|
+
code?: 'undefined_not_allowed';
|
|
1650
|
+
description?: string;
|
|
1651
|
+
data?: Record<string, any>;
|
|
1652
|
+
} | {
|
|
1653
|
+
code?: 'MISSING_BUSINESS_ADDRESS_COUNTRY';
|
|
1654
|
+
description?: string;
|
|
1655
|
+
data?: Record<string, any>;
|
|
1656
|
+
} | {
|
|
1657
|
+
code?: 'MISSING_BUSINESS_ADDRESS_STATE';
|
|
1658
|
+
description?: string;
|
|
1659
|
+
data?: Record<string, any>;
|
|
1660
|
+
};
|
|
1661
|
+
type GetOnlineOrderPreviewValidationErrors = {
|
|
1662
|
+
ruleName?: 'invalid_sort_field';
|
|
1663
|
+
};
|
|
1664
|
+
type GetOfflineOrderPreviewApplicationErrors = {
|
|
1665
|
+
code?: 'PRICING_PLANS_NOT_INSTALLED';
|
|
1666
|
+
description?: string;
|
|
1667
|
+
data?: Record<string, any>;
|
|
1668
|
+
} | {
|
|
1669
|
+
code?: 'ERROR_COUPON_IS_DISABLED';
|
|
1670
|
+
description?: string;
|
|
1671
|
+
data?: CouponsError;
|
|
1672
|
+
} | {
|
|
1673
|
+
code?: 'ERROR_COUPON_USAGE_EXCEEDED';
|
|
1674
|
+
description?: string;
|
|
1675
|
+
data?: CouponsError;
|
|
1676
|
+
} | {
|
|
1677
|
+
code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
|
|
1678
|
+
description?: string;
|
|
1679
|
+
data?: CouponsError;
|
|
1680
|
+
} | {
|
|
1681
|
+
code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
|
|
1682
|
+
description?: string;
|
|
1683
|
+
data?: CouponsError;
|
|
1684
|
+
} | {
|
|
1685
|
+
code?: 'ERROR_COUPON_HAS_EXPIRED';
|
|
1686
|
+
description?: string;
|
|
1687
|
+
data?: CouponsError;
|
|
1688
|
+
} | {
|
|
1689
|
+
code?: 'ERROR_COUPON_DOES_NOT_EXIST';
|
|
1690
|
+
description?: string;
|
|
1691
|
+
data?: CouponsError;
|
|
1692
|
+
} | {
|
|
1693
|
+
code?: 'ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN';
|
|
1694
|
+
description?: string;
|
|
1695
|
+
data?: CouponsError;
|
|
1696
|
+
} | {
|
|
1697
|
+
code?: 'ERROR_INVALID_SUBTOTAL';
|
|
1698
|
+
description?: string;
|
|
1699
|
+
data?: CouponsError;
|
|
1700
|
+
} | {
|
|
1701
|
+
code?: 'undefined_not_allowed';
|
|
1702
|
+
description?: string;
|
|
1703
|
+
data?: Record<string, any>;
|
|
1704
|
+
} | {
|
|
1705
|
+
code?: 'MISSING_BUSINESS_ADDRESS_COUNTRY';
|
|
1706
|
+
description?: string;
|
|
1707
|
+
data?: Record<string, any>;
|
|
1708
|
+
} | {
|
|
1709
|
+
code?: 'MISSING_BUSINESS_ADDRESS_STATE';
|
|
1710
|
+
description?: string;
|
|
1711
|
+
data?: Record<string, any>;
|
|
1712
|
+
};
|
|
1713
|
+
type GetOfflineOrderPreviewValidationErrors = {
|
|
1714
|
+
ruleName?: 'invalid_sort_field';
|
|
1715
|
+
};
|
|
1716
|
+
type GetPricePreviewApplicationErrors = {
|
|
1717
|
+
code?: 'ERROR_COUPON_IS_DISABLED';
|
|
1718
|
+
description?: string;
|
|
1719
|
+
data?: CouponsError;
|
|
1720
|
+
} | {
|
|
1721
|
+
code?: 'ERROR_COUPON_USAGE_EXCEEDED';
|
|
1722
|
+
description?: string;
|
|
1723
|
+
data?: CouponsError;
|
|
1724
|
+
} | {
|
|
1725
|
+
code?: 'ERROR_COUPON_LIMIT_PER_CUSTOMER_EXCEEDED';
|
|
1726
|
+
description?: string;
|
|
1727
|
+
data?: CouponsError;
|
|
1728
|
+
} | {
|
|
1729
|
+
code?: 'ERROR_COUPON_IS_NOT_ACTIVE_YET';
|
|
1730
|
+
description?: string;
|
|
1731
|
+
data?: CouponsError;
|
|
1732
|
+
} | {
|
|
1733
|
+
code?: 'ERROR_COUPON_HAS_EXPIRED';
|
|
1734
|
+
description?: string;
|
|
1735
|
+
data?: CouponsError;
|
|
1736
|
+
} | {
|
|
1737
|
+
code?: 'ERROR_COUPON_DOES_NOT_EXIST';
|
|
1738
|
+
description?: string;
|
|
1739
|
+
data?: CouponsError;
|
|
1740
|
+
} | {
|
|
1741
|
+
code?: 'ERROR_COUPON_NOT_APPLICABLE_FOR_PLAN';
|
|
1742
|
+
description?: string;
|
|
1743
|
+
data?: CouponsError;
|
|
1744
|
+
} | {
|
|
1745
|
+
code?: 'ERROR_INVALID_SUBTOTAL';
|
|
1746
|
+
description?: string;
|
|
1747
|
+
data?: CouponsError;
|
|
1748
|
+
} | {
|
|
1749
|
+
code?: 'MISSING_BUSINESS_ADDRESS_COUNTRY';
|
|
1750
|
+
description?: string;
|
|
1751
|
+
data?: Record<string, any>;
|
|
1752
|
+
} | {
|
|
1753
|
+
code?: 'MISSING_BUSINESS_ADDRESS_STATE';
|
|
1754
|
+
description?: string;
|
|
1755
|
+
data?: Record<string, any>;
|
|
1756
|
+
};
|
|
1468
1757
|
interface BaseEventMetadata {
|
|
1469
1758
|
/**
|
|
1470
1759
|
* App instance ID.
|
|
@@ -1513,54 +1802,315 @@ interface OrderAutoRenewCanceledEnvelope {
|
|
|
1513
1802
|
data: OrderAutoRenewCanceled;
|
|
1514
1803
|
metadata: EventMetadata;
|
|
1515
1804
|
}
|
|
1805
|
+
/**
|
|
1806
|
+
* Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
|
|
1807
|
+
*
|
|
1808
|
+
* This webhook is *not* triggered in the following scenarios:
|
|
1809
|
+
* + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
|
|
1810
|
+
* + 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.
|
|
1811
|
+
* @permissionScope Manage Orders
|
|
1812
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1813
|
+
* @permissionScope Read Orders
|
|
1814
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1815
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1816
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1817
|
+
* @permissionScope Manage Events
|
|
1818
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1819
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1820
|
+
* @webhook
|
|
1821
|
+
* @eventType wix.pricing_plans.v2.order_auto_renew_canceled
|
|
1822
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1823
|
+
* @slug auto_renew_canceled
|
|
1824
|
+
*/
|
|
1825
|
+
declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
|
|
1516
1826
|
interface OrderCanceledEnvelope {
|
|
1517
1827
|
data: OrderCanceled;
|
|
1518
1828
|
metadata: EventMetadata;
|
|
1519
1829
|
}
|
|
1830
|
+
/**
|
|
1831
|
+
* Triggered when an order is canceled.
|
|
1832
|
+
*
|
|
1833
|
+
* This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
|
|
1834
|
+
* + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
|
|
1835
|
+
* + 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.
|
|
1836
|
+
* @permissionScope Manage Orders
|
|
1837
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1838
|
+
* @permissionScope Read Orders
|
|
1839
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1840
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1841
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1842
|
+
* @permissionScope Manage Events
|
|
1843
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1844
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1845
|
+
* @webhook
|
|
1846
|
+
* @eventType wix.pricing_plans.v2.order_canceled
|
|
1847
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1848
|
+
* @slug canceled
|
|
1849
|
+
*/
|
|
1850
|
+
declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
|
|
1520
1851
|
interface OrderCycleStartedEnvelope {
|
|
1521
1852
|
data: OrderCycleStarted;
|
|
1522
1853
|
metadata: EventMetadata;
|
|
1523
1854
|
}
|
|
1855
|
+
/**
|
|
1856
|
+
* Triggered at the start of a new payment cycle for an existing order.
|
|
1857
|
+
*
|
|
1858
|
+
* Not triggered at the initial start of an offline order.
|
|
1859
|
+
* @permissionScope Manage Orders
|
|
1860
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1861
|
+
* @permissionScope Read Orders
|
|
1862
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1863
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1864
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1865
|
+
* @permissionScope Manage Events
|
|
1866
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1867
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1868
|
+
* @webhook
|
|
1869
|
+
* @eventType wix.pricing_plans.v2.order_cycle_started
|
|
1870
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1871
|
+
* @slug cycle_started
|
|
1872
|
+
*/
|
|
1873
|
+
declare function onOrderCycleStarted(handler: (event: OrderCycleStartedEnvelope) => void | Promise<void>): void;
|
|
1524
1874
|
interface OrderEndDatePostponedEnvelope {
|
|
1525
1875
|
data: OrderEndDatePostponed;
|
|
1526
1876
|
metadata: EventMetadata;
|
|
1527
1877
|
}
|
|
1878
|
+
/**
|
|
1879
|
+
* Triggered when an order's `endDate` is postponed.
|
|
1880
|
+
* @permissionScope Manage Orders
|
|
1881
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1882
|
+
* @permissionScope Read Orders
|
|
1883
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1884
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1885
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1886
|
+
* @permissionScope Manage Events
|
|
1887
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1888
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1889
|
+
* @webhook
|
|
1890
|
+
* @eventType wix.pricing_plans.v2.order_end_date_postponed
|
|
1891
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1892
|
+
* @slug end_date_postponed
|
|
1893
|
+
*/
|
|
1894
|
+
declare function onOrderEndDatePostponed(handler: (event: OrderEndDatePostponedEnvelope) => void | Promise<void>): void;
|
|
1528
1895
|
interface OrderEndedEnvelope {
|
|
1529
1896
|
data: OrderEnded;
|
|
1530
1897
|
metadata: EventMetadata;
|
|
1531
1898
|
}
|
|
1899
|
+
/**
|
|
1900
|
+
* Triggered when an order ends.
|
|
1901
|
+
*
|
|
1902
|
+
* This webhook is triggered:
|
|
1903
|
+
* + When an order expires at the end of the current payment cycle.
|
|
1904
|
+
* + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`.
|
|
1905
|
+
* @permissionScope Manage Orders
|
|
1906
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1907
|
+
* @permissionScope Read Orders
|
|
1908
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1909
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1910
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1911
|
+
* @permissionScope Manage Events
|
|
1912
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1913
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1914
|
+
* @webhook
|
|
1915
|
+
* @eventType wix.pricing_plans.v2.order_ended
|
|
1916
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1917
|
+
* @slug ended
|
|
1918
|
+
*/
|
|
1919
|
+
declare function onOrderEnded(handler: (event: OrderEndedEnvelope) => void | Promise<void>): void;
|
|
1532
1920
|
interface OrderMarkedAsPaidEnvelope {
|
|
1533
1921
|
data: OrderMarkedAsPaid;
|
|
1534
1922
|
metadata: EventMetadata;
|
|
1535
1923
|
}
|
|
1924
|
+
/**
|
|
1925
|
+
* Triggered when an offline order is marked as paid.
|
|
1926
|
+
* @permissionScope Manage Orders
|
|
1927
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1928
|
+
* @permissionScope Read Orders
|
|
1929
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1930
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1931
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1932
|
+
* @permissionScope Manage Events
|
|
1933
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1934
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1935
|
+
* @webhook
|
|
1936
|
+
* @eventType wix.pricing_plans.v2.order_marked_as_paid
|
|
1937
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1938
|
+
* @slug marked_as_paid
|
|
1939
|
+
*/
|
|
1940
|
+
declare function onOrderMarkedAsPaid(handler: (event: OrderMarkedAsPaidEnvelope) => void | Promise<void>): void;
|
|
1536
1941
|
interface OrderPausedEnvelope {
|
|
1537
1942
|
data: OrderPaused;
|
|
1538
1943
|
metadata: EventMetadata;
|
|
1539
1944
|
}
|
|
1945
|
+
/**
|
|
1946
|
+
* Triggered when an order is paused.
|
|
1947
|
+
* @permissionScope Manage Orders
|
|
1948
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1949
|
+
* @permissionScope Read Orders
|
|
1950
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1951
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1952
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1953
|
+
* @permissionScope Manage Events
|
|
1954
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1955
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1956
|
+
* @webhook
|
|
1957
|
+
* @eventType wix.pricing_plans.v2.order_paused
|
|
1958
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1959
|
+
* @slug paused
|
|
1960
|
+
*/
|
|
1961
|
+
declare function onOrderPaused(handler: (event: OrderPausedEnvelope) => void | Promise<void>): void;
|
|
1540
1962
|
interface OrderPurchasedEnvelope {
|
|
1541
1963
|
data: OrderPurchased;
|
|
1542
1964
|
metadata: EventMetadata;
|
|
1543
1965
|
}
|
|
1966
|
+
/**
|
|
1967
|
+
* Triggered for any of the following purchase events:
|
|
1968
|
+
* + Order is paid in full.
|
|
1969
|
+
* + At least 1 order cycle payment is paid for.
|
|
1970
|
+
* + Offline order is created, even if not yet marked as paid.
|
|
1971
|
+
* + Free order is created.
|
|
1972
|
+
* @permissionScope Manage Orders
|
|
1973
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1974
|
+
* @permissionScope Read Orders
|
|
1975
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1976
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1977
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1978
|
+
* @permissionScope Manage Events
|
|
1979
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1980
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
1981
|
+
* @webhook
|
|
1982
|
+
* @eventType wix.pricing_plans.v2.order_purchased
|
|
1983
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
1984
|
+
* @slug purchased
|
|
1985
|
+
*/
|
|
1986
|
+
declare function onOrderPurchased(handler: (event: OrderPurchasedEnvelope) => void | Promise<void>): void;
|
|
1544
1987
|
interface OrderResumedEnvelope {
|
|
1545
1988
|
data: OrderResumed;
|
|
1546
1989
|
metadata: EventMetadata;
|
|
1547
1990
|
}
|
|
1991
|
+
/**
|
|
1992
|
+
* Triggered when a paused order is resumed.
|
|
1993
|
+
* @permissionScope Manage Orders
|
|
1994
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
1995
|
+
* @permissionScope Read Orders
|
|
1996
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
1997
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
1998
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
1999
|
+
* @permissionScope Manage Events
|
|
2000
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2001
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2002
|
+
* @webhook
|
|
2003
|
+
* @eventType wix.pricing_plans.v2.order_resumed
|
|
2004
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2005
|
+
* @slug resumed
|
|
2006
|
+
*/
|
|
2007
|
+
declare function onOrderResumed(handler: (event: OrderResumedEnvelope) => void | Promise<void>): void;
|
|
1548
2008
|
interface OrderStartedEnvelope {
|
|
1549
2009
|
data: OrderStarted;
|
|
1550
2010
|
metadata: EventMetadata;
|
|
1551
2011
|
}
|
|
2012
|
+
/**
|
|
2013
|
+
* Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
|
|
2014
|
+
* @permissionScope Manage Orders
|
|
2015
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2016
|
+
* @permissionScope Read Orders
|
|
2017
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
2018
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
2019
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
2020
|
+
* @permissionScope Manage Events
|
|
2021
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2022
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2023
|
+
* @webhook
|
|
2024
|
+
* @eventType wix.pricing_plans.v2.order_started
|
|
2025
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2026
|
+
* @slug started
|
|
2027
|
+
*/
|
|
2028
|
+
declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
|
|
1552
2029
|
interface OrderUpdatedEnvelope {
|
|
1553
2030
|
entity: Order;
|
|
1554
2031
|
metadata: EventMetadata;
|
|
1555
2032
|
}
|
|
2033
|
+
/**
|
|
2034
|
+
* Triggered for any of the following update events:
|
|
2035
|
+
*
|
|
2036
|
+
* + Order is paid for. Order Purchased is also triggered.
|
|
2037
|
+
* + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
|
|
2038
|
+
* + New payment cycle of an order starts. Order Cycle Started is also triggered.
|
|
2039
|
+
* + Offline order is marked as paid. Order Marked As Paid is also triggered.
|
|
2040
|
+
* + End date of the order is postponed. Order End Date Postponed is also triggered
|
|
2041
|
+
* + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
|
|
2042
|
+
* + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
|
|
2043
|
+
* @permissionScope Manage Orders
|
|
2044
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2045
|
+
* @permissionScope Read Orders
|
|
2046
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
2047
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
2048
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
2049
|
+
* @permissionScope Manage Events
|
|
2050
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2051
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2052
|
+
* @webhook
|
|
2053
|
+
* @eventType wix.pricing_plans.v2.order_updated
|
|
2054
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
|
|
2055
|
+
* @slug updated
|
|
2056
|
+
*/
|
|
2057
|
+
declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
|
|
1556
2058
|
interface OrderCreatedEnvelope {
|
|
1557
2059
|
entity: Order;
|
|
1558
2060
|
metadata: EventMetadata;
|
|
1559
2061
|
}
|
|
2062
|
+
/**
|
|
2063
|
+
* Triggered when an order is created.
|
|
2064
|
+
* @permissionScope Manage Orders
|
|
2065
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2066
|
+
* @permissionScope Read Orders
|
|
2067
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
2068
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
2069
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
2070
|
+
* @permissionScope Manage Events
|
|
2071
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2072
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2073
|
+
* @webhook
|
|
2074
|
+
* @eventType wix.pricing_plans.v2.order_created
|
|
2075
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
|
|
2076
|
+
* @slug created
|
|
2077
|
+
*/
|
|
2078
|
+
declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
|
|
1560
2079
|
interface OrderStartDateChangedEnvelope {
|
|
1561
2080
|
data: OrderStartDateChanged;
|
|
1562
2081
|
metadata: EventMetadata;
|
|
1563
2082
|
}
|
|
2083
|
+
/**
|
|
2084
|
+
* Triggered when an order's `startDate` is changed.
|
|
2085
|
+
* @permissionScope Manage Orders
|
|
2086
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
|
|
2087
|
+
* @permissionScope Read Orders
|
|
2088
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
|
|
2089
|
+
* @permissionScope Manage plans and orders of Pricing Plans
|
|
2090
|
+
* @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
|
|
2091
|
+
* @permissionScope Manage Events
|
|
2092
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
2093
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2094
|
+
* @webhook
|
|
2095
|
+
* @eventType wix.pricing_plans.v2.order_start_date_changed
|
|
2096
|
+
* @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
|
|
2097
|
+
* @slug start_date_changed
|
|
2098
|
+
*/
|
|
2099
|
+
declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
|
|
2100
|
+
type OrderNonNullablePaths = `_id` | `planId` | `subscriptionId` | `buyer.memberId` | `buyer.contactId` | `priceDetails.subscription.cycleDuration.unit` | `priceDetails.subtotal` | `priceDetails.discount` | `priceDetails.tax.name` | `priceDetails.tax.includedInPrice` | `priceDetails.tax.rate` | `priceDetails.tax.amount` | `priceDetails.total` | `priceDetails.planPrice` | `priceDetails.currency` | `priceDetails.coupon.code` | `priceDetails.coupon.amount` | `priceDetails.coupon._id` | `pricing.subscription.cycleDuration.unit` | `pricing.prices` | `pricing.prices.${number}.duration.cycleFrom` | `pricing.prices.${number}.price.subtotal` | `pricing.prices.${number}.price.coupon.code` | `pricing.prices.${number}.price.coupon.amount` | `pricing.prices.${number}.price.coupon._id` | `pricing.prices.${number}.price.discount` | `pricing.prices.${number}.price.tax.name` | `pricing.prices.${number}.price.tax.includedInPrice` | `pricing.prices.${number}.price.tax.rate` | `pricing.prices.${number}.price.tax.amount` | `pricing.prices.${number}.price.total` | `pricing.prices.${number}.price.currency` | `pricing.prices.${number}.price.proration` | `type` | `status` | `cancellation.cause` | `cancellation.effectiveAt` | `lastPaymentStatus` | `pausePeriods` | `pausePeriods.${number}.status` | `currentCycle.index` | `planName` | `planDescription` | `planPrice`;
|
|
2101
|
+
/**
|
|
2102
|
+
* Retrieves an order by ID.
|
|
2103
|
+
* @param _id - Order ID.
|
|
2104
|
+
* @public
|
|
2105
|
+
* @requiredField _id
|
|
2106
|
+
* @param options - Options to use when getting an order.
|
|
2107
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2108
|
+
* @applicableIdentity APP
|
|
2109
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
|
|
2110
|
+
*/
|
|
2111
|
+
declare function managementGetOrder(_id: string, options?: ManagementGetOrderOptions): Promise<NonNullablePaths<GetOrderResponse, {
|
|
2112
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
2113
|
+
}[OrderNonNullablePaths]>>;
|
|
1564
2114
|
interface ManagementGetOrderOptions {
|
|
1565
2115
|
/**
|
|
1566
2116
|
* Predefined set of fields to return.
|
|
@@ -1569,6 +2119,20 @@ interface ManagementGetOrderOptions {
|
|
|
1569
2119
|
*/
|
|
1570
2120
|
fieldSet?: SetWithLiterals;
|
|
1571
2121
|
}
|
|
2122
|
+
/**
|
|
2123
|
+
* Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
|
|
2124
|
+
*
|
|
2125
|
+
* By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
|
|
2126
|
+
* `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
|
|
2127
|
+
* @public
|
|
2128
|
+
* @param options - Filtering, sorting, and pagination options.
|
|
2129
|
+
* @permissionId PRICING_PLANS.READ_ORDERS
|
|
2130
|
+
* @applicableIdentity APP
|
|
2131
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
|
|
2132
|
+
*/
|
|
2133
|
+
declare function managementListOrders(options?: ManagementListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, {
|
|
2134
|
+
[P in OrderNonNullablePaths]: `orders.${number}.${P}`;
|
|
2135
|
+
}[OrderNonNullablePaths]>>;
|
|
1572
2136
|
interface ManagementListOrdersOptions {
|
|
1573
2137
|
/**
|
|
1574
2138
|
* Filter by a buyer's member ID, from the Members API.
|
|
@@ -1611,6 +2175,120 @@ interface ManagementListOrdersOptions {
|
|
|
1611
2175
|
*/
|
|
1612
2176
|
fieldSet?: SetWithLiterals;
|
|
1613
2177
|
}
|
|
2178
|
+
/**
|
|
2179
|
+
* 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.
|
|
2180
|
+
*
|
|
2181
|
+
* New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
|
|
2182
|
+
* Can't postpone an order with `status`: `PAUSED`.
|
|
2183
|
+
* @param _id - Order ID.
|
|
2184
|
+
* @param endDate - New end date and time.
|
|
2185
|
+
*
|
|
2186
|
+
* Must be later than the current end date and time.
|
|
2187
|
+
* @public
|
|
2188
|
+
* @requiredField _id
|
|
2189
|
+
* @requiredField endDate
|
|
2190
|
+
* @param options - Options for postponing the end date of an order.
|
|
2191
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2192
|
+
* @applicableIdentity APP
|
|
2193
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
|
|
2194
|
+
*/
|
|
2195
|
+
declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
|
|
2196
|
+
/**
|
|
2197
|
+
* Cancels an existing order.
|
|
2198
|
+
*
|
|
2199
|
+
* For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
|
|
2200
|
+
* For orders with one-time payments, a cancellation can only be set for `IMMEDIATELY`.
|
|
2201
|
+
*
|
|
2202
|
+
* #### Canceling during the free trial period.
|
|
2203
|
+
*
|
|
2204
|
+
* When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
|
|
2205
|
+
* of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
|
|
2206
|
+
* of the free trial period.
|
|
2207
|
+
*
|
|
2208
|
+
* When a Wix user cancels an ordered plan during the free trial period, they choose whether to apply the cancellation
|
|
2209
|
+
* `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. Canceling `IMMEDIATELY` will end the subscription for the buyer
|
|
2210
|
+
* immediately, even during the free trial period and the buyer won't be billed. Canceling at the
|
|
2211
|
+
* `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period.
|
|
2212
|
+
* Then, the subscription ends and the buyer is not billed.
|
|
2213
|
+
* @param _id - Order ID.
|
|
2214
|
+
* @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
|
|
2215
|
+
* @public
|
|
2216
|
+
* @requiredField _id
|
|
2217
|
+
* @requiredField effectiveAt
|
|
2218
|
+
* @param options - Options for canceling orders.
|
|
2219
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2220
|
+
* @applicableIdentity APP
|
|
2221
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
|
|
2222
|
+
*/
|
|
2223
|
+
declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
2224
|
+
/**
|
|
2225
|
+
* Marks an offline order as paid.
|
|
2226
|
+
* > __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.
|
|
2227
|
+
*
|
|
2228
|
+
* Marking an offline order as paid causes the following changes:
|
|
2229
|
+
* - The order's `lastPaymentStatus` changes to `"PAID"`.
|
|
2230
|
+
* - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
|
|
2231
|
+
*
|
|
2232
|
+
* An error occurs if you attempt to:
|
|
2233
|
+
* - Mark an already-paid, offline order as paid. You cannot mark an offline order as paid twice.
|
|
2234
|
+
* - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
|
|
2235
|
+
* @param _id - Order ID.
|
|
2236
|
+
* @public
|
|
2237
|
+
* @requiredField _id
|
|
2238
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2239
|
+
* @applicableIdentity APP
|
|
2240
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
|
|
2241
|
+
*/
|
|
2242
|
+
declare function markAsPaid(_id: string): Promise<void>;
|
|
2243
|
+
/**
|
|
2244
|
+
* Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
|
|
2245
|
+
*
|
|
2246
|
+
* Only orders with `status`: `ACTIVE` can be paused.
|
|
2247
|
+
* For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
|
|
2248
|
+
* Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`.
|
|
2249
|
+
* The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
|
|
2250
|
+
*
|
|
2251
|
+
* To resume a paused order, call Resume Order.
|
|
2252
|
+
* @param _id - Order ID.
|
|
2253
|
+
* @public
|
|
2254
|
+
* @requiredField _id
|
|
2255
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2256
|
+
* @applicableIdentity APP
|
|
2257
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
|
|
2258
|
+
*/
|
|
2259
|
+
declare function pauseOrder(_id: string): Promise<void>;
|
|
2260
|
+
/**
|
|
2261
|
+
* Resumes a paused order. For orders with recurring payments, it also restarts the payment schedule.
|
|
2262
|
+
*
|
|
2263
|
+
* Resuming an order causes the following changes:
|
|
2264
|
+
* - The order status changes to `"ACTIVE"`.
|
|
2265
|
+
* - The `pausePeriods` array is updated.
|
|
2266
|
+
* - The `endDate` for the order is adjusted to include the pause period.
|
|
2267
|
+
* - For orders with recurring payments, the payment schedule is restarted.
|
|
2268
|
+
* - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
|
|
2269
|
+
*
|
|
2270
|
+
* To pause an order, call Pause Order.
|
|
2271
|
+
* @param _id - Order ID.
|
|
2272
|
+
* @public
|
|
2273
|
+
* @requiredField _id
|
|
2274
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2275
|
+
* @applicableIdentity APP
|
|
2276
|
+
* @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
|
|
2277
|
+
*/
|
|
2278
|
+
declare function resumeOrder(_id: string): Promise<void>;
|
|
2279
|
+
/**
|
|
2280
|
+
* Retrieves an order for the currently logged-in member by ID.
|
|
2281
|
+
* @param _id - Order ID.
|
|
2282
|
+
* @public
|
|
2283
|
+
* @requiredField _id
|
|
2284
|
+
* @param options - Options for getting a logged-in member's order.
|
|
2285
|
+
* @permissionId PRICING_PLANS.READ_OWN_ORDERS
|
|
2286
|
+
* @applicableIdentity APP
|
|
2287
|
+
* @applicableIdentity MEMBER
|
|
2288
|
+
* @returns Requested order.
|
|
2289
|
+
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder
|
|
2290
|
+
*/
|
|
2291
|
+
declare function memberGetOrder(_id: string, options?: MemberGetOrderOptions): Promise<NonNullablePaths<Order, OrderNonNullablePaths>>;
|
|
1614
2292
|
interface MemberGetOrderOptions {
|
|
1615
2293
|
/**
|
|
1616
2294
|
* Predefined set of fields to return.
|
|
@@ -1619,6 +2297,18 @@ interface MemberGetOrderOptions {
|
|
|
1619
2297
|
*/
|
|
1620
2298
|
fieldSet?: SetWithLiterals;
|
|
1621
2299
|
}
|
|
2300
|
+
/**
|
|
2301
|
+
* Retrieves a list of up to 100 pricing plan orders for currently logged-in member.
|
|
2302
|
+
* @public
|
|
2303
|
+
* @param options - Filtering, sorting, and pagination options.
|
|
2304
|
+
* @permissionId PRICING_PLANS.READ_OWN_ORDERS
|
|
2305
|
+
* @applicableIdentity APP
|
|
2306
|
+
* @applicableIdentity MEMBER
|
|
2307
|
+
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.ListOrders
|
|
2308
|
+
*/
|
|
2309
|
+
declare function memberListOrders(options?: MemberListOrdersOptions): Promise<NonNullablePaths<MemberListOrdersResponse, {
|
|
2310
|
+
[P in OrderNonNullablePaths]: `orders.${number}.${P}`;
|
|
2311
|
+
}[OrderNonNullablePaths]>>;
|
|
1622
2312
|
interface MemberListOrdersOptions {
|
|
1623
2313
|
/**
|
|
1624
2314
|
* Filter by plan IDs.
|
|
@@ -1648,6 +2338,45 @@ interface MemberListOrdersOptions {
|
|
|
1648
2338
|
*/
|
|
1649
2339
|
fieldSet?: SetWithLiterals;
|
|
1650
2340
|
}
|
|
2341
|
+
/**
|
|
2342
|
+
* Cancels an order. Recurring orders can be canceled either immediately or at the next payment date. One time orders can only be canceled immediately.
|
|
2343
|
+
*
|
|
2344
|
+
* There may be some operations that continue to be processed before the status of the order is changed to `"CANCELED"`. For example, payments might need to be refunded before the order is fully canceled.
|
|
2345
|
+
*
|
|
2346
|
+
* Canceling during the free trial period: When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end of the free trial period and they won't be billed. The buyer may continue using the benefits until the end of the free trial period.
|
|
2347
|
+
*
|
|
2348
|
+
* >**Note:**
|
|
2349
|
+
* >This method requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
|
|
2350
|
+
* @param _id - Order ID.
|
|
2351
|
+
* @param effectiveAt - Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately.
|
|
2352
|
+
* @public
|
|
2353
|
+
* @requiredField _id
|
|
2354
|
+
* @requiredField effectiveAt
|
|
2355
|
+
* @param options - Options for requesting a cancellation.
|
|
2356
|
+
* @permissionId PRICING_PLANS.MANAGE_OWN_ORDERS
|
|
2357
|
+
* @applicableIdentity APP
|
|
2358
|
+
* @applicableIdentity MEMBER
|
|
2359
|
+
* @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.RequestCancellation
|
|
2360
|
+
*/
|
|
2361
|
+
declare function requestCancellation(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
|
|
2362
|
+
/**
|
|
2363
|
+
* Creates an online order for a site member.
|
|
2364
|
+
*
|
|
2365
|
+
* If this method is called by a site member ([SDK](https://dev.wix.com/docs/sdk/articles/get-started/about-identities#site-member) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/about-identities#site-member)), the plan is automatically ordered on behalf of that site member. Otherwise, you must specify `onBehalf.memberId` in your call.
|
|
2366
|
+
*
|
|
2367
|
+
* When an online order is created, but payment hasn't been processed, its status is set to `DRAFT`. After the payment has been processed, if the start date is in the future the order's status is set to `PENDING`. Otherwise, it's set to `ACTIVE`.
|
|
2368
|
+
* @param planId - Plan ID.
|
|
2369
|
+
* @public
|
|
2370
|
+
* @requiredField options.onBehalf.memberId
|
|
2371
|
+
* @requiredField planId
|
|
2372
|
+
* @fqn com.wixpress.membership.v2.orders.CheckoutService.CreateOnlineOrder
|
|
2373
|
+
*/
|
|
2374
|
+
declare function createOnlineOrder(planId: string, options?: NonNullablePaths<CreateOnlineOrderOptions, `onBehalf.memberId`>): Promise<NonNullablePaths<CreateOnlineOrderResponse, {
|
|
2375
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
2376
|
+
}[OrderNonNullablePaths]> & {
|
|
2377
|
+
__applicationErrorsType?: CreateOnlineOrderApplicationErrors;
|
|
2378
|
+
__validationErrorsType?: CreateOnlineOrderValidationErrors;
|
|
2379
|
+
}>;
|
|
1651
2380
|
interface CreateOnlineOrderOptions {
|
|
1652
2381
|
/**
|
|
1653
2382
|
* Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
@@ -1669,6 +2398,40 @@ interface CreateOnlineOrderOptions {
|
|
|
1669
2398
|
*/
|
|
1670
2399
|
submissionId?: string | null;
|
|
1671
2400
|
}
|
|
2401
|
+
/**
|
|
2402
|
+
* Creates an order for a buyer who purchased the plan with an offline transaction.
|
|
2403
|
+
*
|
|
2404
|
+
* An offline order is handled off of the Wix site and is marked as `type`: `offline`. If a pricing plan
|
|
2405
|
+
* has a limit on the amount of purchases per buyer, that limit is ignored for offline orders.
|
|
2406
|
+
* Tax is only applied if the site [has it configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection).
|
|
2407
|
+
*
|
|
2408
|
+
* When creating a free offline order:
|
|
2409
|
+
* The order's status is set to `"PENDING"` if the start date is in the future. Otherwise, the status is set to `"ACTIVE"`.
|
|
2410
|
+
* The order's last payment status is set to `"NOT_APPLICABLE"`. "
|
|
2411
|
+
*
|
|
2412
|
+
* When creating a non-free offline order:
|
|
2413
|
+
* The order's status is set to `"PENDING"` if the start date is in the future. Otherwise, the status is set to `"ACTIVE"`.
|
|
2414
|
+
* The order's last payment status is set to `"UNPAID"` or `"PAID"` based on the data passed in the `paid` boolean in the request.
|
|
2415
|
+
*
|
|
2416
|
+
* Payment for an offline order can be set in 1 of 2 ways:
|
|
2417
|
+
* + During order creation, set `paid`: `true`.
|
|
2418
|
+
* + After creation, call Mark As Paid.
|
|
2419
|
+
* @param planId - ID of the plan being ordered, from the Plans API.
|
|
2420
|
+
* @param memberId - ID of the member ordering the plan, from the Members API.
|
|
2421
|
+
* @public
|
|
2422
|
+
* @requiredField memberId
|
|
2423
|
+
* @requiredField planId
|
|
2424
|
+
* @param options - Options for creating an offline order.
|
|
2425
|
+
* @permissionId PRICING_PLANS.REGISTER_OFFLINE_ORDERS
|
|
2426
|
+
* @applicableIdentity APP
|
|
2427
|
+
* @fqn com.wixpress.membership.v2.orders.CheckoutService.CreateOfflineOrder
|
|
2428
|
+
*/
|
|
2429
|
+
declare function createOfflineOrder(planId: string, memberId: string, options?: CreateOfflineOrderOptions): Promise<NonNullablePaths<CreateOfflineOrderResponse, {
|
|
2430
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
2431
|
+
}[OrderNonNullablePaths]> & {
|
|
2432
|
+
__applicationErrorsType?: CreateOfflineOrderApplicationErrors;
|
|
2433
|
+
__validationErrorsType?: CreateOfflineOrderValidationErrors;
|
|
2434
|
+
}>;
|
|
1672
2435
|
interface CreateOfflineOrderOptions {
|
|
1673
2436
|
/**
|
|
1674
2437
|
* Start date and time for the ordered plan in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
@@ -1694,6 +2457,26 @@ interface CreateOfflineOrderOptions {
|
|
|
1694
2457
|
*/
|
|
1695
2458
|
submissionId?: string | null;
|
|
1696
2459
|
}
|
|
2460
|
+
/**
|
|
2461
|
+
* Returns an `order` object that represents a potential online order for a site member.
|
|
2462
|
+
*
|
|
2463
|
+
* You can use this method to show a site member a preview of an online order before [creating](https://dev.wix.com/docs/rest/business-solutions/pricing-plans/pricing-plans/orders/create-online-order) it.
|
|
2464
|
+
*
|
|
2465
|
+
* This method must be called using the site member identity ([SDK](https://dev.wix.com/docs/sdk/articles/get-started/about-identities#site-member) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/about-identities#site-member)). Therefore, [Wix apps](https://dev.wix.com/docs/build-apps) can't currently call this method using REST.
|
|
2466
|
+
* @param planId - Plan ID.
|
|
2467
|
+
* @public
|
|
2468
|
+
* @requiredField planId
|
|
2469
|
+
* @permissionId PRICING_PLANS.PURCHASE_PLANS
|
|
2470
|
+
* @applicableIdentity APP
|
|
2471
|
+
* @applicableIdentity MEMBER
|
|
2472
|
+
* @fqn com.wixpress.membership.v2.orders.CheckoutService.GetOnlineOrderPreview
|
|
2473
|
+
*/
|
|
2474
|
+
declare function getOnlineOrderPreview(planId: string, options?: GetOnlineOrderPreviewOptions): Promise<NonNullablePaths<GetOnlineOrderPreviewResponse, {
|
|
2475
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
2476
|
+
}[OrderNonNullablePaths] | `purchaseLimitExceeded`> & {
|
|
2477
|
+
__applicationErrorsType?: GetOnlineOrderPreviewApplicationErrors;
|
|
2478
|
+
__validationErrorsType?: GetOnlineOrderPreviewValidationErrors;
|
|
2479
|
+
}>;
|
|
1697
2480
|
interface GetOnlineOrderPreviewOptions {
|
|
1698
2481
|
/**
|
|
1699
2482
|
* Start date and time for the plan of the order preview in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
@@ -1708,6 +2491,34 @@ interface GetOnlineOrderPreviewOptions {
|
|
|
1708
2491
|
*/
|
|
1709
2492
|
couponCode?: string | null;
|
|
1710
2493
|
}
|
|
2494
|
+
/**
|
|
2495
|
+
* Performs a dry run of a purchase and provides an order preview.
|
|
2496
|
+
*
|
|
2497
|
+
* The preview uses the same logic as purchasing a plan, but the preview is not saved. Because an order is not actually
|
|
2498
|
+
* created, the preview order's `orderId` and `subscriptionId` are displayed as a string of multiple zero characters
|
|
2499
|
+
* (`000000-0000`). Tax is only calculated if the site [has it configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection).
|
|
2500
|
+
* <br>
|
|
2501
|
+
* If a pricing plan has a limit on the amount of purchases per buyer, that limit is not considered for generating the preview.
|
|
2502
|
+
* But, if that limit has been reached and this order would then exceed the amount of purchases permitted for this buyer, then
|
|
2503
|
+
* `purchaseLimitExceeded` will return as `true`.
|
|
2504
|
+
*
|
|
2505
|
+
* To get a general price preview for a plan that's not buyer-specific, call Get Price Preview.
|
|
2506
|
+
* @param memberId - Member ID of the buyer the previewed order is for, from the Members API.
|
|
2507
|
+
* @public
|
|
2508
|
+
* @requiredField memberId
|
|
2509
|
+
* @requiredField planId
|
|
2510
|
+
* @param options - Options for previewing the offline order.
|
|
2511
|
+
* @param planId - ID of the plan of the previewed order.
|
|
2512
|
+
* @permissionId PRICING_PLANS.MANAGE_ORDERS
|
|
2513
|
+
* @applicableIdentity APP
|
|
2514
|
+
* @fqn com.wixpress.membership.v2.orders.CheckoutService.GetOfflineOrderPreview
|
|
2515
|
+
*/
|
|
2516
|
+
declare function getOfflineOrderPreview(planId: string, memberId: string, options?: GetOfflineOrderPreviewOptions): Promise<NonNullablePaths<GetOfflineOrderPreviewResponse, {
|
|
2517
|
+
[P in OrderNonNullablePaths]: `order.${P}`;
|
|
2518
|
+
}[OrderNonNullablePaths] | `purchaseLimitExceeded`> & {
|
|
2519
|
+
__applicationErrorsType?: GetOfflineOrderPreviewApplicationErrors;
|
|
2520
|
+
__validationErrorsType?: GetOfflineOrderPreviewValidationErrors;
|
|
2521
|
+
}>;
|
|
1711
2522
|
interface GetOfflineOrderPreviewOptions {
|
|
1712
2523
|
/**
|
|
1713
2524
|
* Start date and time for plan of the previewed order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
|
|
@@ -1722,6 +2533,27 @@ interface GetOfflineOrderPreviewOptions {
|
|
|
1722
2533
|
*/
|
|
1723
2534
|
couponCode?: string | null;
|
|
1724
2535
|
}
|
|
2536
|
+
/**
|
|
2537
|
+
* Retrieves a plan's pricing.
|
|
2538
|
+
*
|
|
2539
|
+
* The price preview uses the same logic as purchasing a plan, but the preview is not saved. Tax is only applied if
|
|
2540
|
+
* the site [has it configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection). The price is returned
|
|
2541
|
+
* in the pricing model format used for orders. Learn more about pricing models ([REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/introduction#wix-pricing-plans_pricing-plans_introduction_pricing-models)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/introduction#pricing-models)).
|
|
2542
|
+
*
|
|
2543
|
+
* Buyers do not have to be logged in to preview the price, and as such, the details returned are not buyer-specific. To
|
|
2544
|
+
* generate a preview of a purchase for a specific buyer, call Get Offline Order Preview.
|
|
2545
|
+
* @param planId - ID of plan to preview.
|
|
2546
|
+
* @public
|
|
2547
|
+
* @requiredField planId
|
|
2548
|
+
* @param options - Options for getting a price preview.
|
|
2549
|
+
* @permissionId PRICING_PLANS.READ_PUBLIC_PLANS
|
|
2550
|
+
* @applicableIdentity APP
|
|
2551
|
+
* @applicableIdentity VISITOR
|
|
2552
|
+
* @fqn com.wixpress.membership.v2.orders.CheckoutService.GetPricePreview
|
|
2553
|
+
*/
|
|
2554
|
+
declare function getPricePreview(planId: string, options?: GetPricePreviewOptions): Promise<NonNullablePaths<GetPricePreviewResponse, `price.subscription.cycleDuration.unit` | `price.subtotal` | `price.discount` | `price.tax.name` | `price.tax.includedInPrice` | `price.tax.rate` | `price.tax.amount` | `price.total` | `price.planPrice` | `price.currency` | `price.coupon.code` | `price.coupon.amount` | `price.coupon._id` | `prices` | `prices.${number}.duration.cycleFrom` | `prices.${number}.price.subtotal` | `prices.${number}.price.coupon.code` | `prices.${number}.price.coupon.amount` | `prices.${number}.price.coupon._id` | `prices.${number}.price.discount` | `prices.${number}.price.tax.name` | `prices.${number}.price.tax.includedInPrice` | `prices.${number}.price.tax.rate` | `prices.${number}.price.tax.amount` | `prices.${number}.price.total` | `prices.${number}.price.currency` | `prices.${number}.price.proration`> & {
|
|
2555
|
+
__applicationErrorsType?: GetPricePreviewApplicationErrors;
|
|
2556
|
+
}>;
|
|
1725
2557
|
interface GetPricePreviewOptions {
|
|
1726
2558
|
/**
|
|
1727
2559
|
* Coupon code to apply, from the Coupons API.
|
|
@@ -1731,4 +2563,4 @@ interface GetPricePreviewOptions {
|
|
|
1731
2563
|
couponCode?: string | null;
|
|
1732
2564
|
}
|
|
1733
2565
|
|
|
1734
|
-
export { type
|
|
2566
|
+
export { type ActionEvent, type ApplicationError, type ApplyCouponRequest, type ApplyCouponResponse, type BaseEventMetadata, type BulkActionMetadata, type BulkOrderResult, type BulkPauseOrderRequest, type BulkPauseOrderResponse, type BulkResumeOrderRequest, type BulkResumeOrderResponse, type Buyer, type CancelOrderRequest, type CancelOrderResponse, type Cancellation, CancellationCause, type CancellationCauseWithLiterals, CancellationEffectiveAt, type CancellationEffectiveAtWithLiterals, type Captcha, type ChangeStartDateRequest, type ChangeStartDateResponse, type Coupon, type CouponsError, type CreateExternalOrderRequest, type CreateExternalOrderResponse, type CreateGuestOnlineOrderRequest, type CreateGuestOnlineOrderResponse, type CreateOfflineOrderApplicationErrors, type CreateOfflineOrderOptions, type CreateOfflineOrderRequest, type CreateOfflineOrderResponse, type CreateOfflineOrderValidationErrors, type CreateOnlineOrderApplicationErrors, type CreateOnlineOrderOptions, type CreateOnlineOrderRequest, type CreateOnlineOrderResponse, type CreateOnlineOrderValidationErrors, type CurrentCycle, type CursorPaging, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type Duration, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type Fee, type FormData, type GetAvailableOrderActionsRequest, type GetAvailableOrderActionsResponse, type GetGuestOnlineOrderPreviewRequest, type GetGuestOnlineOrderPreviewResponse, type GetOfflineOrderPreviewApplicationErrors, type GetOfflineOrderPreviewOptions, type GetOfflineOrderPreviewRequest, type GetOfflineOrderPreviewResponse, type GetOfflineOrderPreviewValidationErrors, type GetOnlineOrderPreviewApplicationErrors, type GetOnlineOrderPreviewOptions, type GetOnlineOrderPreviewRequest, type GetOnlineOrderPreviewResponse, type GetOnlineOrderPreviewValidationErrors, type GetOrderRequest, type GetOrderResponse, type GetOrdersStatsRequest, type GetOrdersStatsResponse, type GetPricePreviewApplicationErrors, type GetPricePreviewOptions, type GetPricePreviewRequest, type GetPricePreviewResponse, type Guest, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type ListOrdersRequest, type ListOrdersResponse, type ManagementGetOrderOptions, type ManagementListOrdersOptions, type MarkAsPaidRequest, type MarkAsPaidResponse, type MemberGetOrderOptions, type MemberGetOrderRequest, type MemberGetOrderResponse, type MemberListOrdersOptions, type MemberListOrdersRequest, type MemberListOrdersResponse, type MessageEnvelope, type OnBehalf, type Order, type OrderAutoRenewCanceled, type OrderAutoRenewCanceledEnvelope, type OrderCanceled, type OrderCanceledEnvelope, type OrderCreatedEnvelope, type OrderCycle, type OrderCycleStarted, type OrderCycleStartedEnvelope, type OrderEndDatePostponed, type OrderEndDatePostponedEnvelope, type OrderEnded, type OrderEndedEnvelope, type OrderMarkedAsPaid, type OrderMarkedAsPaidEnvelope, OrderMethod, type OrderMethodWithLiterals, type OrderPaused, type OrderPausedEnvelope, type OrderPurchased, type OrderPurchasedEnvelope, type OrderResumed, type OrderResumedEnvelope, type OrderStartDateChanged, type OrderStartDateChangedEnvelope, type OrderStarted, type OrderStartedEnvelope, OrderStatus, type OrderStatusWithLiterals, OrderType, type OrderTypeWithLiterals, type OrderUpdatedEnvelope, type OrdersQueryOrdersRequest, type OrdersQueryOrdersResponse, type Paging, type PagingMetadataV2, type PauseOrderRequest, type PauseOrderResponse, type PausePeriod, PaymentStatus, type PaymentStatusWithLiterals, PeriodUnit, type PeriodUnitWithLiterals, type PostponeEndDateRequest, type PostponeEndDateResponse, type Price, type PriceDetails, type PriceDetailsPricingModelOneOf, type PriceDuration, type PricingDetails, type PricingDetailsPricingModelOneOf, type QueryOrdersRequest, type QueryOrdersResponse, type QueryV2, type QueryV2PagingMethodOneOf, ReasonNotSuspendable, type ReasonNotSuspendableWithLiterals, type Recurrence, type RequestCancellationRequest, type RequestCancellationResponse, type RestoreInfo, type ResumeOrderRequest, type ResumeOrderResponse, Set, type SetSubmissionRequest, type SetSubmissionResponse, type SetWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, type SpannedPrice, Status, type StatusWithLiterals, type Tax, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, cancelOrder, createOfflineOrder, createOnlineOrder, getOfflineOrderPreview, getOnlineOrderPreview, getPricePreview, managementGetOrder, managementListOrders, markAsPaid, memberGetOrder, memberListOrders, onOrderAutoRenewCanceled, onOrderCanceled, onOrderCreated, onOrderCycleStarted, onOrderEndDatePostponed, onOrderEnded, onOrderMarkedAsPaid, onOrderPaused, onOrderPurchased, onOrderResumed, onOrderStartDateChanged, onOrderStarted, onOrderUpdated, pauseOrder, postponeEndDate, requestCancellation, resumeOrder };
|