@wix/auto_sdk_packages_packages 1.0.4 → 1.0.6
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 +29 -12
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/{premium-reseller-v1-packages-packages.universal-CeJKqN8_.d.ts → index.typings.d.ts} +315 -1
- package/build/cjs/index.typings.js +867 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +2 -1
- package/build/es/index.d.mts +29 -12
- package/build/es/index.mjs.map +1 -1
- package/build/es/{premium-reseller-v1-packages-packages.universal-CeJKqN8_.d.mts → index.typings.d.mts} +315 -1
- package/build/es/index.typings.mjs +817 -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 +29 -12
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/{premium-reseller-v1-packages-packages.universal-CeJKqN8_.d.ts → index.typings.d.ts} +315 -1
- package/build/internal/cjs/index.typings.js +867 -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 +29 -12
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/{premium-reseller-v1-packages-packages.universal-CeJKqN8_.d.mts → index.typings.d.mts} +315 -1
- package/build/internal/es/index.typings.mjs +817 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +2 -1
- package/package.json +4 -3
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
|
+
|
|
1
3
|
/**
|
|
2
4
|
* A package is group of instances of Wix services that a reseller offers to a
|
|
3
5
|
* customer as part of a single transaction.
|
|
@@ -746,6 +748,13 @@ interface Subscription {
|
|
|
746
748
|
* format.
|
|
747
749
|
*/
|
|
748
750
|
countryCode?: string | null;
|
|
751
|
+
/**
|
|
752
|
+
* Seats of the product that the subscription was purchased for.
|
|
753
|
+
* Will be Null for products that don't support seats.
|
|
754
|
+
* @min 1
|
|
755
|
+
* @max 500
|
|
756
|
+
*/
|
|
757
|
+
seats?: number | null;
|
|
749
758
|
}
|
|
750
759
|
interface BillingReference {
|
|
751
760
|
/**
|
|
@@ -1053,6 +1062,12 @@ interface ContractSwitched {
|
|
|
1053
1062
|
* + `DOWNGRADE`: The product has been downgraded.
|
|
1054
1063
|
*/
|
|
1055
1064
|
productAdjustment?: ProductAdjustmentWithLiterals;
|
|
1065
|
+
/**
|
|
1066
|
+
* Number of seats before the contract switch.
|
|
1067
|
+
* @min 1
|
|
1068
|
+
* @max 500
|
|
1069
|
+
*/
|
|
1070
|
+
previousSeats?: number | null;
|
|
1056
1071
|
}
|
|
1057
1072
|
/** Copied from SBS */
|
|
1058
1073
|
declare enum ContractSwitchType {
|
|
@@ -1407,6 +1422,39 @@ interface FixBrokenMigrationRequest {
|
|
|
1407
1422
|
}
|
|
1408
1423
|
interface FixBrokenMigrationResponse {
|
|
1409
1424
|
}
|
|
1425
|
+
type PackagesNonNullablePaths = `_id` | `accountId` | `productInstances` | `productInstances.${number}.billingInfo.type` | `productInstances.${number}.billingInfo.cycleDuration.unit` | `productInstances.${number}.billingInfo.cycleDuration.count` | `productInstances.${number}.instanceId` | `productInstances.${number}.catalogProductId` | `productInstances.${number}.status` | `productInstances.${number}.failure.code` | `productInstances.${number}.failure.message`;
|
|
1426
|
+
/**
|
|
1427
|
+
* Creates a new package.
|
|
1428
|
+
*
|
|
1429
|
+
* Deprecated: This method is deprecated and will be removed by 2024-12-31.
|
|
1430
|
+
* Use com.wixpress.premium.reseller.packages.v1.Packages.CreatePackageV2 instead.
|
|
1431
|
+
*
|
|
1432
|
+
* HTTP Request:
|
|
1433
|
+
* POST /v1/packages
|
|
1434
|
+
*
|
|
1435
|
+
* Permissions:
|
|
1436
|
+
* Requires the "premium.reseller-package.manage" permission with MANUAL type.
|
|
1437
|
+
*
|
|
1438
|
+
* Event:
|
|
1439
|
+
* A PRIVATE callback will be triggered when the package is successfully created.
|
|
1440
|
+
*
|
|
1441
|
+
* Required Fields:
|
|
1442
|
+
* - CreatePackageRequest.products
|
|
1443
|
+
*
|
|
1444
|
+
* Maturity: BETA
|
|
1445
|
+
* Exposure: PUBLIC
|
|
1446
|
+
* @public
|
|
1447
|
+
* @documentationMaturity preview
|
|
1448
|
+
* @requiredField options.products
|
|
1449
|
+
* @permissionId premium.reseller-package.manage
|
|
1450
|
+
* @fqn com.wixpress.premium.reseller.packages.v1.Packages.CreatePackage
|
|
1451
|
+
* @deprecated
|
|
1452
|
+
* @replacedBy com.wixpress.premium.reseller.packages.v1.Packages.CreatePackageV2
|
|
1453
|
+
* @targetRemovalDate 2024-12-31
|
|
1454
|
+
*/
|
|
1455
|
+
declare function createPackage(options?: NonNullablePaths<CreatePackageOptions, `products`>): Promise<NonNullablePaths<CreatePackageResponse, {
|
|
1456
|
+
[P in PackagesNonNullablePaths]: `package.${P}`;
|
|
1457
|
+
}[PackagesNonNullablePaths]>>;
|
|
1410
1458
|
interface CreatePackageOptions {
|
|
1411
1459
|
/**
|
|
1412
1460
|
* Idempotency key.
|
|
@@ -1425,6 +1473,45 @@ interface CreatePackageOptions {
|
|
|
1425
1473
|
*/
|
|
1426
1474
|
products: ProductInstance[];
|
|
1427
1475
|
}
|
|
1476
|
+
/**
|
|
1477
|
+
* Creates a package of product instances.
|
|
1478
|
+
*
|
|
1479
|
+
*
|
|
1480
|
+
* You must pass the relevant Wix account ID in the header of the call. In
|
|
1481
|
+
* the DIY flow, we recommend to pass the customer's sub-account ID instead
|
|
1482
|
+
* of your main reseller account ID.
|
|
1483
|
+
*
|
|
1484
|
+
* You may also pass a Wix site ID for each product in the body of the call.
|
|
1485
|
+
* If you omit the site ID, a floating product instance is created.
|
|
1486
|
+
*
|
|
1487
|
+
* When Wix customers purchase a specific paid service or product, Wix may offer
|
|
1488
|
+
* them time-limited free access to a different product. For example, customers
|
|
1489
|
+
* get a voucher for a free 1-year domain registration when purchasing any Wix
|
|
1490
|
+
* Premium plan. If you want to offer your customers the same benefit, create a
|
|
1491
|
+
* package containing the original product first. Then, create a second package
|
|
1492
|
+
* with the additional product. In the second Create Package call, pass the
|
|
1493
|
+
* instance ID of the original product as `referenceProductInstanceId`. This way,
|
|
1494
|
+
* Wix doesn't charge you for the additional product. Make sure that the status
|
|
1495
|
+
* of the referenced product is either `"PENDING"` or `"ACTIVE"`. Note that you
|
|
1496
|
+
* can use each product instance only a single time as reference instance.
|
|
1497
|
+
*
|
|
1498
|
+
* You need to pass a `countryCode` to specify where customers can claim
|
|
1499
|
+
* vouchers that may come with a product. Contact the
|
|
1500
|
+
* [Wix B2B sales team](mailto:bizdev@wix.com) to get information about
|
|
1501
|
+
* vouchers and supported locations.
|
|
1502
|
+
*
|
|
1503
|
+
* > **Important**: This call requires an account level API key and cannot be
|
|
1504
|
+
* > authenticated with the standard authorization header.
|
|
1505
|
+
* @public
|
|
1506
|
+
* @documentationMaturity preview
|
|
1507
|
+
* @requiredField options.products
|
|
1508
|
+
* @requiredField options.products.countryCode
|
|
1509
|
+
* @permissionId premium.reseller-package.manage
|
|
1510
|
+
* @fqn com.wixpress.premium.reseller.packages.v1.Packages.CreatePackageV2
|
|
1511
|
+
*/
|
|
1512
|
+
declare function createPackageV2(options?: NonNullablePaths<CreatePackageV2Options, `products` | `products.${number}.countryCode`>): Promise<NonNullablePaths<CreatePackageResponse, {
|
|
1513
|
+
[P in PackagesNonNullablePaths]: `package.${P}`;
|
|
1514
|
+
}[PackagesNonNullablePaths]>>;
|
|
1428
1515
|
interface CreatePackageV2Options {
|
|
1429
1516
|
/**
|
|
1430
1517
|
* Idempotency key.
|
|
@@ -1443,6 +1530,32 @@ interface CreatePackageV2Options {
|
|
|
1443
1530
|
*/
|
|
1444
1531
|
products: ProductInstance[];
|
|
1445
1532
|
}
|
|
1533
|
+
/**
|
|
1534
|
+
* Cancels all product instances included in the package and the customer
|
|
1535
|
+
* immediately loses access to the canceled functionality.
|
|
1536
|
+
*
|
|
1537
|
+
*
|
|
1538
|
+
* You must pass the ID of the Wix account that the package belongs to in the
|
|
1539
|
+
* header of the call. The call fails, if the package and Wix account don't
|
|
1540
|
+
* match.
|
|
1541
|
+
*
|
|
1542
|
+
* If a canceled product instance is a requirement for another Wix service, that
|
|
1543
|
+
* functionality is also no longer available to the customer. For example, if
|
|
1544
|
+
* you cancel a Premium plan, a previously connected domain is automatically
|
|
1545
|
+
* disconnected from the site.
|
|
1546
|
+
*
|
|
1547
|
+
* > **Important**: This call requires an account level API key and cannot be
|
|
1548
|
+
* > authenticated with the standard authorization header.
|
|
1549
|
+
* @param _id - ID of the package to cancel.
|
|
1550
|
+
* @public
|
|
1551
|
+
* @documentationMaturity preview
|
|
1552
|
+
* @requiredField _id
|
|
1553
|
+
* @permissionId premium.reseller-package.manage
|
|
1554
|
+
* @fqn com.wixpress.premium.reseller.packages.v1.Packages.CancelPackage
|
|
1555
|
+
*/
|
|
1556
|
+
declare function cancelPackage(_id: string, options?: CancelPackageOptions): Promise<NonNullablePaths<CancelPackageResponse, {
|
|
1557
|
+
[P in PackagesNonNullablePaths]: `package.${P}`;
|
|
1558
|
+
}[PackagesNonNullablePaths]>>;
|
|
1446
1559
|
interface CancelPackageOptions {
|
|
1447
1560
|
/**
|
|
1448
1561
|
* Idempotency key.
|
|
@@ -1450,6 +1563,79 @@ interface CancelPackageOptions {
|
|
|
1450
1563
|
*/
|
|
1451
1564
|
idempotencyKey?: string | null;
|
|
1452
1565
|
}
|
|
1566
|
+
/**
|
|
1567
|
+
* Retrieves a package.
|
|
1568
|
+
*
|
|
1569
|
+
*
|
|
1570
|
+
* You must pass the ID of the Wix account that the package belongs to in the
|
|
1571
|
+
* header of the call. The call fails, if the package and Wix account don't
|
|
1572
|
+
* match.
|
|
1573
|
+
*
|
|
1574
|
+
* > **Important**: This call requires an account level API key and cannot be
|
|
1575
|
+
* > authenticated with the standard authorization header.
|
|
1576
|
+
* @param _id - Package ID.
|
|
1577
|
+
* @public
|
|
1578
|
+
* @documentationMaturity preview
|
|
1579
|
+
* @requiredField _id
|
|
1580
|
+
* @permissionId premium.reseller-package.read
|
|
1581
|
+
* @returns Retrieved package.
|
|
1582
|
+
* @fqn com.wixpress.premium.reseller.packages.v1.Packages.GetPackage
|
|
1583
|
+
*/
|
|
1584
|
+
declare function getPackage(_id: string): Promise<NonNullablePaths<Package, PackagesNonNullablePaths>>;
|
|
1585
|
+
/**
|
|
1586
|
+
* Retrieves a list of packages, given the provided paging, filtering, and sorting.
|
|
1587
|
+
*
|
|
1588
|
+
*
|
|
1589
|
+
* You must pass the ID of the Wix account that the packages belong to in the
|
|
1590
|
+
* header of the call. The call returns packages that belong to the parent
|
|
1591
|
+
* account, regardless if you pass the ID of a parent or sub-account. In case
|
|
1592
|
+
* you want to retrieve only packages that belong to a sub-account, you must
|
|
1593
|
+
* pass the sub-account ID as `filter` in the `query` object like this:
|
|
1594
|
+
*
|
|
1595
|
+
* ```json
|
|
1596
|
+
* {
|
|
1597
|
+
* "query": {
|
|
1598
|
+
* "filter": {
|
|
1599
|
+
* "accountId": {
|
|
1600
|
+
* "$eq": "<SUB_ACCOUNT_ID>"
|
|
1601
|
+
* }
|
|
1602
|
+
* }
|
|
1603
|
+
* }
|
|
1604
|
+
* }
|
|
1605
|
+
* ```
|
|
1606
|
+
*
|
|
1607
|
+
* Query Packages runs with these defaults, which you can override:
|
|
1608
|
+
*
|
|
1609
|
+
* - `createdDate` is sorted in `DESC` order
|
|
1610
|
+
* - `cursorPaging.limit` is `100`
|
|
1611
|
+
*
|
|
1612
|
+
* By default `pagingMetadata.cursors` are returned, unless you specifically pass
|
|
1613
|
+
* `query.paging`.
|
|
1614
|
+
*
|
|
1615
|
+
* The maximum for `cursorPaging.limit` is `100`.
|
|
1616
|
+
*
|
|
1617
|
+
* If you pass a cursor token that you have received in a previous Query Package response,
|
|
1618
|
+
* passing additional sort or filter information results in an invalid cursor
|
|
1619
|
+
* error. Since the received cursor token already holds all the needed information
|
|
1620
|
+
* for sort and filter. Changing the sort and filter properties during the span of
|
|
1621
|
+
* a cursor query isn't supported. But you can provide a different limit.
|
|
1622
|
+
*
|
|
1623
|
+
* For field support for filters and sorting,
|
|
1624
|
+
* see [Query Packages: Supported Filters and Sorting](https://dev.wix.com/api/rest/account-level-apis/resellers/supported-filters).
|
|
1625
|
+
*
|
|
1626
|
+
* To learn about working with _Query_ endpoints, see
|
|
1627
|
+
* [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
|
|
1628
|
+
* [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
|
|
1629
|
+
* and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
|
|
1630
|
+
*
|
|
1631
|
+
* > **Important**: This call requires an account level API key and cannot be
|
|
1632
|
+
* > authenticated with the standard authorization header.
|
|
1633
|
+
* @public
|
|
1634
|
+
* @documentationMaturity preview
|
|
1635
|
+
* @permissionId premium.reseller-package.read
|
|
1636
|
+
* @fqn com.wixpress.premium.reseller.packages.v1.Packages.QueryPackages
|
|
1637
|
+
*/
|
|
1638
|
+
declare function queryPackages(): PackagesQueryBuilder;
|
|
1453
1639
|
interface QueryCursorResult {
|
|
1454
1640
|
cursors: Cursors;
|
|
1455
1641
|
hasNext: () => boolean;
|
|
@@ -1475,6 +1661,27 @@ interface PackagesQueryBuilder {
|
|
|
1475
1661
|
/** @documentationMaturity preview */
|
|
1476
1662
|
find: () => Promise<PackagesQueryResult>;
|
|
1477
1663
|
}
|
|
1664
|
+
/**
|
|
1665
|
+
* Assigns a product instance to a site.
|
|
1666
|
+
*
|
|
1667
|
+
* You must pass the ID of the Wix account that the product instance belongs to in the header of the call.
|
|
1668
|
+
*
|
|
1669
|
+
* The customer immediately gains access to features included in the assigned service. It's up to the reseller to decide whether assigning a product instance affects the customer’s payment.
|
|
1670
|
+
*
|
|
1671
|
+
* It's possible to assign a product instance that's already assigned to a site, to a different site without [unassigning](/packages/unassign-product-instance-from-site) it first. But if the call fails in such a situation, the product instance may either remain assigned to the original site or become unassigned. You can confirm the instance's status by [retrieving the relevant package](/packages/get-package).
|
|
1672
|
+
*
|
|
1673
|
+
* > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1674
|
+
* @public
|
|
1675
|
+
* @documentationMaturity preview
|
|
1676
|
+
* @requiredField identifiers
|
|
1677
|
+
* @requiredField identifiers.instanceId
|
|
1678
|
+
* @requiredField identifiers.siteId
|
|
1679
|
+
* @permissionId premium.reseller-package.manage
|
|
1680
|
+
* @fqn com.wixpress.premium.reseller.packages.v1.Packages.AssignProductInstanceToSite
|
|
1681
|
+
*/
|
|
1682
|
+
declare function assignProductInstanceToSite(identifiers: NonNullablePaths<AssignProductInstanceToSiteIdentifiers, `instanceId` | `siteId`>, options?: AssignProductInstanceToSiteOptions): Promise<NonNullablePaths<AssignProductInstanceToSiteResponse, {
|
|
1683
|
+
[P in PackagesNonNullablePaths]: `package.${P}`;
|
|
1684
|
+
}[PackagesNonNullablePaths]>>;
|
|
1478
1685
|
interface AssignProductInstanceToSiteIdentifiers {
|
|
1479
1686
|
/**
|
|
1480
1687
|
* ID of the product instance to assign to a site.
|
|
@@ -1494,6 +1701,28 @@ interface AssignProductInstanceToSiteOptions {
|
|
|
1494
1701
|
*/
|
|
1495
1702
|
idempotencyKey?: string | null;
|
|
1496
1703
|
}
|
|
1704
|
+
/**
|
|
1705
|
+
* Unassigns a product instance from a site.
|
|
1706
|
+
*
|
|
1707
|
+
* You must pass the ID of the Wix account that the product instance belongs to in the header of the call.
|
|
1708
|
+
*
|
|
1709
|
+
* The product instance becomes floating and the customer immediately looses access to features included in the unassigned service. It's up to the reseller to decide whether unassigning a product instance affects the customer’s payment.
|
|
1710
|
+
*
|
|
1711
|
+
* If an unassigned product instance is a requirement for another service, that service may not be available to the customer any longer. For example, if you unassign a `Combo Plan` plan from a site, a previously connected domain is disconnected.
|
|
1712
|
+
*
|
|
1713
|
+
* You can assign floating product instances to sites using the [Assign Product Instance to Site](/packages/assign-product-instance-to-site) method.
|
|
1714
|
+
*
|
|
1715
|
+
* > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
|
|
1716
|
+
* @param instanceId - ID of the product instance to unassign from a site.
|
|
1717
|
+
* @public
|
|
1718
|
+
* @documentationMaturity preview
|
|
1719
|
+
* @requiredField instanceId
|
|
1720
|
+
* @permissionId premium.reseller-package.manage
|
|
1721
|
+
* @fqn com.wixpress.premium.reseller.packages.v1.Packages.UnassignProductInstanceFromSite
|
|
1722
|
+
*/
|
|
1723
|
+
declare function unassignProductInstanceFromSite(instanceId: string, options?: UnassignProductInstanceFromSiteOptions): Promise<NonNullablePaths<UnassignProductInstanceFromSiteResponse, {
|
|
1724
|
+
[P in PackagesNonNullablePaths]: `package.${P}`;
|
|
1725
|
+
}[PackagesNonNullablePaths]>>;
|
|
1497
1726
|
interface UnassignProductInstanceFromSiteOptions {
|
|
1498
1727
|
/**
|
|
1499
1728
|
* Idempotency key.
|
|
@@ -1501,6 +1730,36 @@ interface UnassignProductInstanceFromSiteOptions {
|
|
|
1501
1730
|
*/
|
|
1502
1731
|
idempotencyKey?: string | null;
|
|
1503
1732
|
}
|
|
1733
|
+
/**
|
|
1734
|
+
* Cancels a product instance.
|
|
1735
|
+
*
|
|
1736
|
+
*
|
|
1737
|
+
* You must pass the ID of the Wix account that the product instance belongs
|
|
1738
|
+
* to in the header of the call. The call fails, if the product instance and
|
|
1739
|
+
* Wix account don't match.
|
|
1740
|
+
*
|
|
1741
|
+
* The customer immediately loses access to features included in the
|
|
1742
|
+
* canceled service. It's up to the reseller to decide whether the adjustment
|
|
1743
|
+
* affects the customer’s payment.
|
|
1744
|
+
*
|
|
1745
|
+
* If a canceled service is a requirement for another service, that service
|
|
1746
|
+
* may not be available to the customer any longer. For example, if you cancel
|
|
1747
|
+
* a `Combo Plan` plan, a previously connected domain is disconnected
|
|
1748
|
+
* from the site.
|
|
1749
|
+
*
|
|
1750
|
+
*
|
|
1751
|
+
* > **Important**: This call requires an account level API key and cannot be
|
|
1752
|
+
* > authenticated with the standard authorization header.
|
|
1753
|
+
* @param instanceId - ID of the product instance to cancel.
|
|
1754
|
+
* @public
|
|
1755
|
+
* @documentationMaturity preview
|
|
1756
|
+
* @requiredField instanceId
|
|
1757
|
+
* @permissionId premium.reseller-package.manage
|
|
1758
|
+
* @fqn com.wixpress.premium.reseller.packages.v1.Packages.CancelProductInstance
|
|
1759
|
+
*/
|
|
1760
|
+
declare function cancelProductInstance(instanceId: string, options?: CancelProductInstanceOptions): Promise<NonNullablePaths<CancelProductInstanceResponse, {
|
|
1761
|
+
[P in PackagesNonNullablePaths]: `package.${P}`;
|
|
1762
|
+
}[PackagesNonNullablePaths]>>;
|
|
1504
1763
|
interface CancelProductInstanceOptions {
|
|
1505
1764
|
/**
|
|
1506
1765
|
* Idempotency key.
|
|
@@ -1508,6 +1767,48 @@ interface CancelProductInstanceOptions {
|
|
|
1508
1767
|
*/
|
|
1509
1768
|
idempotencyKey?: string | null;
|
|
1510
1769
|
}
|
|
1770
|
+
/**
|
|
1771
|
+
* Upgrades or downgrades a product instance. For example, you can upgrade a
|
|
1772
|
+
* customer's `Business Unlimited Premium` plan to `Business VIP` using this
|
|
1773
|
+
* endpoint.
|
|
1774
|
+
*
|
|
1775
|
+
*
|
|
1776
|
+
* You must pass the ID of the Wix account that the product instance belongs
|
|
1777
|
+
* to in the header of the call. The call fails, if the product instance and
|
|
1778
|
+
* Wix account don't match.
|
|
1779
|
+
*
|
|
1780
|
+
* The customer has immediate access to new features, while losing access to
|
|
1781
|
+
* features not included in the new service. It's up to the reseller to
|
|
1782
|
+
* decide whether the adjustment affects the customer’s payment.
|
|
1783
|
+
*
|
|
1784
|
+
* You can only exchange a product instance with a service of the same type.
|
|
1785
|
+
* Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for details about
|
|
1786
|
+
* which services belong to the same type.
|
|
1787
|
+
*
|
|
1788
|
+
* You must provide either a new `catalogProductId` or a new `billingInfo`
|
|
1789
|
+
* object. The new billing cycle must be supported for the product. Contact the
|
|
1790
|
+
* [Wix B2B sales team](mailto:bizdev@wix.com) for information
|
|
1791
|
+
* about which billing cycles are supported for each product. If you adjust the
|
|
1792
|
+
* billing cycle for a product instance with `RECURRING` payments, you must
|
|
1793
|
+
* also provide `billingInfo.cycleDuration.unit`.
|
|
1794
|
+
*
|
|
1795
|
+
* If a removed feature is a requirement for another service, that service
|
|
1796
|
+
* may not be available to the customer any longer. For example, if you downgrade a
|
|
1797
|
+
* `Business Unlimited` plan to `Business Basic`, the site owners won’t be
|
|
1798
|
+
* able to use `Pro eCommerce Features` any longer.
|
|
1799
|
+
*
|
|
1800
|
+
* > **Important**: This call requires an account level API key and cannot be
|
|
1801
|
+
* > authenticated with the standard authorization header.
|
|
1802
|
+
* @param instanceId - ID of the product instance to adjust.
|
|
1803
|
+
* @public
|
|
1804
|
+
* @documentationMaturity preview
|
|
1805
|
+
* @requiredField instanceId
|
|
1806
|
+
* @permissionId premium.reseller-package.manage
|
|
1807
|
+
* @fqn com.wixpress.premium.reseller.packages.v1.Packages.AdjustProductInstanceSpecifications
|
|
1808
|
+
*/
|
|
1809
|
+
declare function adjustProductInstanceSpecifications(instanceId: string, options?: AdjustProductInstanceSpecificationsOptions): Promise<NonNullablePaths<AdjustProductInstanceSpecificationsResponse, {
|
|
1810
|
+
[P in PackagesNonNullablePaths]: `package.${P}`;
|
|
1811
|
+
}[PackagesNonNullablePaths]>>;
|
|
1511
1812
|
interface AdjustProductInstanceSpecificationsOptions {
|
|
1512
1813
|
/**
|
|
1513
1814
|
* Idempotency key.
|
|
@@ -1543,6 +1844,19 @@ interface AdjustProductInstanceSpecificationsOptions {
|
|
|
1543
1844
|
*/
|
|
1544
1845
|
discountCode?: string | null;
|
|
1545
1846
|
}
|
|
1847
|
+
/**
|
|
1848
|
+
* Updates a package's external ID field.
|
|
1849
|
+
* @public
|
|
1850
|
+
* @documentationMaturity preview
|
|
1851
|
+
* @requiredField identifiers
|
|
1852
|
+
* @requiredField identifiers.externalId
|
|
1853
|
+
* @requiredField identifiers.packageId
|
|
1854
|
+
* @permissionId PREMIUM.PACKAGE_UPDATE_EXTERNAL_ID
|
|
1855
|
+
* @fqn com.wixpress.premium.reseller.packages.v1.Packages.UpdatePackageExternalId
|
|
1856
|
+
*/
|
|
1857
|
+
declare function updatePackageExternalId(identifiers: NonNullablePaths<UpdatePackageExternalIdIdentifiers, `externalId` | `packageId`>): Promise<NonNullablePaths<UpdatePackageExternalIdResponse, {
|
|
1858
|
+
[P in PackagesNonNullablePaths]: `updatedPackage.${P}`;
|
|
1859
|
+
}[PackagesNonNullablePaths]>>;
|
|
1546
1860
|
interface UpdatePackageExternalIdIdentifiers {
|
|
1547
1861
|
/**
|
|
1548
1862
|
* ID of the package to update.
|
|
@@ -1556,4 +1870,4 @@ interface UpdatePackageExternalIdIdentifiers {
|
|
|
1556
1870
|
externalId: string;
|
|
1557
1871
|
}
|
|
1558
1872
|
|
|
1559
|
-
export { type
|
|
1873
|
+
export { type ActionEvent, type AdjustProductInstanceSpecificationsOptions, type AdjustProductInstanceSpecificationsRequest, type AdjustProductInstanceSpecificationsResponse, type AdjustedProductInstanceSpecifications, type AssignProductInstanceToSiteIdentifiers, type AssignProductInstanceToSiteOptions, type AssignProductInstanceToSiteRequest, type AssignProductInstanceToSiteResponse, type AssignedProductInstanceToSite, type BillingReference, type Cancel, type CancelPackageOptions, type CancelPackageRequest, type CancelPackageResponse, type CancelProductInstanceOptions, type CancelProductInstanceRequest, type CancelProductInstanceResponse, type CancellationDetails, type Complete, ContractSwitchReason, type ContractSwitchReasonWithLiterals, ContractSwitchType, type ContractSwitchTypeWithLiterals, type ContractSwitched, type CountPackagesRequest, type CountPackagesResponse, type CreatePackageOptions, type CreatePackageRequest, type CreatePackageResponse, type CreatePackageV2Options, type CursorPaging, type Cursors, type Cycle, type CycleCycleSelectorOneOf, CycleDescriptorType, type CycleDescriptorTypeWithLiterals, type CycleInterval, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type FailureReason, FailureReasonFailureReason, type FailureReasonFailureReasonWithLiterals, type FailureReportRequest, FieldToUpdate, type FieldToUpdateWithLiterals, type FixBrokenMigrationRequest, type FixBrokenMigrationResponse, type GetPackageRequest, type GetPackageResponse, type IdentificationData, type IdentificationDataIdOneOf, Initiator, type InitiatorWithLiterals, type Interval, IntervalIntervalUnit, type IntervalIntervalUnitWithLiterals, IntervalUnit, type IntervalUnitWithLiterals, type MessageEnvelope, type MigrateSubscriptionToPackagesRequest, type MigrateSubscriptionToPackagesResponse, type OneTime, type Package, type PackageCanceled, type PackagesQueryBuilder, type PackagesQueryResult, type Paging, type PagingMetadataV2, PriceIncreaseTrigger, type PriceIncreaseTriggerWithLiterals, ProductAdjustment, type ProductAdjustmentWithLiterals, type ProductInstance, type ProductInstanceCanceled, type ProductInstanceContractDetailsOneOf, type ProductInstanceCycle, type ProductInstanceFailed, type ProductInstanceUpdated, type ProductPriceIncreaseData, ProviderName, type ProviderNameWithLiterals, type QueryPackagesRequest, type QueryPackagesResponse, type QueryV2, type QueryV2PagingMethodOneOf, type ReactivationData, ReactivationReasonEnum, type ReactivationReasonEnumWithLiterals, type RecurringChargeAttemptFailed, type RecurringChargeSucceeded, type Reschedule, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, Status, type StatusWithLiterals, type Subscription, type SubscriptionAssigned, type SubscriptionAutoRenewTurnedOff, type SubscriptionAutoRenewTurnedOn, type SubscriptionCancelled, type SubscriptionCreated, type SubscriptionEvent, type SubscriptionEventEventOneOf, type SubscriptionNearEndOfPeriod, type SubscriptionPendingChange, SubscriptionStatus, type SubscriptionStatusWithLiterals, type SubscriptionTransferred, type SubscriptionUnassigned, type Task, type TaskAction, type TaskActionActionOneOf, type TaskKey, type UnassignProductInstanceFromSiteOptions, type UnassignProductInstanceFromSiteRequest, type UnassignProductInstanceFromSiteResponse, UnassignReason, type UnassignReasonWithLiterals, type UnassignedProductInstanceFromSite, type UpdatePackageExternalIdIdentifiers, type UpdatePackageExternalIdRequest, type UpdatePackageExternalIdResponse, type UpdateProductInstanceRequest, type UpdateProductInstanceResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, adjustProductInstanceSpecifications, assignProductInstanceToSite, cancelPackage, cancelProductInstance, createPackage, createPackageV2, getPackage, queryPackages, unassignProductInstanceFromSite, updatePackageExternalId };
|