@wix/auto_sdk_data_collections 1.0.86 → 1.0.88
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 +1 -1
- package/build/cjs/index.js +1236 -70
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +222 -1
- package/build/cjs/index.typings.js +1132 -69
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +203 -2
- package/build/cjs/meta.js +947 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +1 -1
- package/build/es/index.mjs +1220 -70
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +222 -1
- package/build/es/index.typings.mjs +1116 -69
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +203 -2
- package/build/es/meta.mjs +931 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +135 -3
- package/build/internal/cjs/index.js +1236 -70
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +358 -1
- package/build/internal/cjs/index.typings.js +1132 -69
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +203 -2
- package/build/internal/cjs/meta.js +947 -0
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +135 -3
- package/build/internal/es/index.mjs +1220 -70
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +358 -1
- package/build/internal/es/index.typings.mjs +1116 -69
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +203 -2
- package/build/internal/es/meta.mjs +931 -0
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -907,6 +907,12 @@ declare enum Status {
|
|
|
907
907
|
}
|
|
908
908
|
/** @enumType */
|
|
909
909
|
type StatusWithLiterals = Status | 'PUBLISHED' | 'DRAFT';
|
|
910
|
+
declare enum LifecycleStatus {
|
|
911
|
+
ACTIVE = "ACTIVE",
|
|
912
|
+
MIGRATING_TO_DRAFT_ITEMS = "MIGRATING_TO_DRAFT_ITEMS"
|
|
913
|
+
}
|
|
914
|
+
/** @enumType */
|
|
915
|
+
type LifecycleStatusWithLiterals = LifecycleStatus | 'ACTIVE' | 'MIGRATING_TO_DRAFT_ITEMS';
|
|
910
916
|
declare enum Format {
|
|
911
917
|
/** Letters are converted to lower case and spaces are replaced with dashes before generating the encoded URL. */
|
|
912
918
|
ORIGINAL = "ORIGINAL",
|
|
@@ -972,6 +978,12 @@ type PluginTypeWithLiterals = PluginType | 'PUBLISH' | 'SINGLE_ITEM' | 'URLIZED'
|
|
|
972
978
|
interface PublishPluginOptions {
|
|
973
979
|
/** Default status. */
|
|
974
980
|
defaultStatus?: StatusWithLiterals;
|
|
981
|
+
/**
|
|
982
|
+
* Server-managed lifecycle status.
|
|
983
|
+
* @internal
|
|
984
|
+
* @readonly
|
|
985
|
+
*/
|
|
986
|
+
lifecycleStatus?: LifecycleStatusWithLiterals;
|
|
975
987
|
}
|
|
976
988
|
interface SingleItemPluginOptions {
|
|
977
989
|
/**
|
|
@@ -1577,6 +1589,189 @@ interface DeleteDataCollectionPluginResponse {
|
|
|
1577
1589
|
/** Updated data collection. */
|
|
1578
1590
|
dataCollection?: DataCollection;
|
|
1579
1591
|
}
|
|
1592
|
+
interface AddPublishPluginRequest {
|
|
1593
|
+
/**
|
|
1594
|
+
* ID of the data collection to update.
|
|
1595
|
+
* @maxLength 256
|
|
1596
|
+
*/
|
|
1597
|
+
dataCollectionId: string;
|
|
1598
|
+
/** Publish plugin options. */
|
|
1599
|
+
publishOptions: PublishPluginOptions;
|
|
1600
|
+
/** Action to take when the Draft Items plugin is already installed. */
|
|
1601
|
+
draftItemsPluginConflictAction?: DraftItemsPluginConflictActionWithLiterals;
|
|
1602
|
+
}
|
|
1603
|
+
/** Behavior to apply when adding the Publish plugin to a collection that already has the Draft Items plugin. */
|
|
1604
|
+
declare enum DraftItemsPluginConflictAction {
|
|
1605
|
+
/** Fail if the Draft Items plugin is already installed. */
|
|
1606
|
+
FAIL_WHEN_DRAFT_ITEMS_INSTALLED = "FAIL_WHEN_DRAFT_ITEMS_INSTALLED",
|
|
1607
|
+
/** Discard all draft items in the Draft Items plugin, causing data loss. */
|
|
1608
|
+
DISCARD_DRAFT_ITEMS = "DISCARD_DRAFT_ITEMS",
|
|
1609
|
+
/** Publish all draft items. This overwrites any currently published items with the same IDs. */
|
|
1610
|
+
PUBLISH_DRAFT_ITEMS = "PUBLISH_DRAFT_ITEMS",
|
|
1611
|
+
/** Copy draft items with draft status. If a published version already exists, discard the draft item. */
|
|
1612
|
+
COPY_DRAFT_ITEMS_WITH_DRAFT_STATUS = "COPY_DRAFT_ITEMS_WITH_DRAFT_STATUS"
|
|
1613
|
+
}
|
|
1614
|
+
/** @enumType */
|
|
1615
|
+
type DraftItemsPluginConflictActionWithLiterals = DraftItemsPluginConflictAction | 'FAIL_WHEN_DRAFT_ITEMS_INSTALLED' | 'DISCARD_DRAFT_ITEMS' | 'PUBLISH_DRAFT_ITEMS' | 'COPY_DRAFT_ITEMS_WITH_DRAFT_STATUS';
|
|
1616
|
+
interface AddPublishPluginResponse {
|
|
1617
|
+
/** Updated data collection. */
|
|
1618
|
+
dataCollection?: DataCollection;
|
|
1619
|
+
}
|
|
1620
|
+
interface DeletePublishPluginRequest {
|
|
1621
|
+
/**
|
|
1622
|
+
* ID of the data collection to update.
|
|
1623
|
+
* @maxLength 256
|
|
1624
|
+
*/
|
|
1625
|
+
dataCollectionId: string;
|
|
1626
|
+
}
|
|
1627
|
+
interface DeletePublishPluginResponse {
|
|
1628
|
+
/** Updated data collection. */
|
|
1629
|
+
dataCollection?: DataCollection;
|
|
1630
|
+
}
|
|
1631
|
+
interface AddUrlizedPluginRequest {
|
|
1632
|
+
/**
|
|
1633
|
+
* ID of the data collection to update.
|
|
1634
|
+
* @maxLength 256
|
|
1635
|
+
*/
|
|
1636
|
+
dataCollectionId: string;
|
|
1637
|
+
/** Urlized plugin options. */
|
|
1638
|
+
urlizedOptions: UrlizedPluginOptions;
|
|
1639
|
+
}
|
|
1640
|
+
interface AddUrlizedPluginResponse {
|
|
1641
|
+
/** Updated data collection. */
|
|
1642
|
+
dataCollection?: DataCollection;
|
|
1643
|
+
}
|
|
1644
|
+
interface DeleteUrlizedPluginRequest {
|
|
1645
|
+
/**
|
|
1646
|
+
* ID of the data collection to update.
|
|
1647
|
+
* @maxLength 256
|
|
1648
|
+
*/
|
|
1649
|
+
dataCollectionId: string;
|
|
1650
|
+
}
|
|
1651
|
+
interface DeleteUrlizedPluginResponse {
|
|
1652
|
+
/** Updated data collection. */
|
|
1653
|
+
dataCollection?: DataCollection;
|
|
1654
|
+
}
|
|
1655
|
+
interface AddMultilingualPluginRequest {
|
|
1656
|
+
/**
|
|
1657
|
+
* ID of the data collection to update.
|
|
1658
|
+
* @maxLength 256
|
|
1659
|
+
*/
|
|
1660
|
+
dataCollectionId: string;
|
|
1661
|
+
/** Multilingual plugin options. */
|
|
1662
|
+
multilingualOptions: MultilingualOptions;
|
|
1663
|
+
}
|
|
1664
|
+
interface AddMultilingualPluginResponse {
|
|
1665
|
+
/** Updated data collection. */
|
|
1666
|
+
dataCollection?: DataCollection;
|
|
1667
|
+
}
|
|
1668
|
+
interface DeleteMultilingualPluginRequest {
|
|
1669
|
+
/**
|
|
1670
|
+
* ID of the data collection to update.
|
|
1671
|
+
* @maxLength 256
|
|
1672
|
+
*/
|
|
1673
|
+
dataCollectionId: string;
|
|
1674
|
+
}
|
|
1675
|
+
interface DeleteMultilingualPluginResponse {
|
|
1676
|
+
/** Updated data collection. */
|
|
1677
|
+
dataCollection?: DataCollection;
|
|
1678
|
+
}
|
|
1679
|
+
interface AddCmsPluginRequest {
|
|
1680
|
+
/**
|
|
1681
|
+
* ID of the data collection to update.
|
|
1682
|
+
* @maxLength 256
|
|
1683
|
+
*/
|
|
1684
|
+
dataCollectionId: string;
|
|
1685
|
+
/** CMS plugin options. */
|
|
1686
|
+
cmsOptions: PluginCmsOptions;
|
|
1687
|
+
}
|
|
1688
|
+
interface AddCmsPluginResponse {
|
|
1689
|
+
/** Updated data collection. */
|
|
1690
|
+
dataCollection?: DataCollection;
|
|
1691
|
+
}
|
|
1692
|
+
interface DeleteCmsPluginRequest {
|
|
1693
|
+
/**
|
|
1694
|
+
* ID of the data collection to update.
|
|
1695
|
+
* @maxLength 256
|
|
1696
|
+
*/
|
|
1697
|
+
dataCollectionId: string;
|
|
1698
|
+
}
|
|
1699
|
+
interface DeleteCmsPluginResponse {
|
|
1700
|
+
/** Updated data collection. */
|
|
1701
|
+
dataCollection?: DataCollection;
|
|
1702
|
+
}
|
|
1703
|
+
interface AddCatalogPluginRequest {
|
|
1704
|
+
/**
|
|
1705
|
+
* ID of the data collection to update.
|
|
1706
|
+
* @maxLength 256
|
|
1707
|
+
*/
|
|
1708
|
+
dataCollectionId: string;
|
|
1709
|
+
/** Catalog plugin options. */
|
|
1710
|
+
catalogOptions: CatalogOptions;
|
|
1711
|
+
}
|
|
1712
|
+
interface AddCatalogPluginResponse {
|
|
1713
|
+
/** Updated data collection. */
|
|
1714
|
+
dataCollection?: DataCollection;
|
|
1715
|
+
}
|
|
1716
|
+
interface DeleteCatalogPluginRequest {
|
|
1717
|
+
/**
|
|
1718
|
+
* ID of the data collection to update.
|
|
1719
|
+
* @maxLength 256
|
|
1720
|
+
*/
|
|
1721
|
+
dataCollectionId: string;
|
|
1722
|
+
}
|
|
1723
|
+
interface DeleteCatalogPluginResponse {
|
|
1724
|
+
/** Updated data collection. */
|
|
1725
|
+
dataCollection?: DataCollection;
|
|
1726
|
+
}
|
|
1727
|
+
interface AddDraftItemsPluginRequest {
|
|
1728
|
+
/**
|
|
1729
|
+
* ID of the data collection to update.
|
|
1730
|
+
* @maxLength 256
|
|
1731
|
+
*/
|
|
1732
|
+
dataCollectionId: string;
|
|
1733
|
+
/** Draft Items plugin options. */
|
|
1734
|
+
draftItemsOptions: DraftItemsPluginOptions;
|
|
1735
|
+
/** Action to take when the Publish plugin is already installed. */
|
|
1736
|
+
publishPluginConflictAction?: PublishPluginConflictActionWithLiterals;
|
|
1737
|
+
}
|
|
1738
|
+
/** Behavior to apply when adding the Draft Items plugin to a collection that already has the Publish plugin. */
|
|
1739
|
+
declare enum PublishPluginConflictAction {
|
|
1740
|
+
/** Fail if the Publish plugin is already installed. */
|
|
1741
|
+
FAIL_WHEN_PUBLISH_INSTALLED = "FAIL_WHEN_PUBLISH_INSTALLED",
|
|
1742
|
+
/** Copy draft items with draft status. If a published version already exists, discard the draft item. */
|
|
1743
|
+
COPY_DRAFT_ITEMS_WITH_DRAFT_STATUS = "COPY_DRAFT_ITEMS_WITH_DRAFT_STATUS"
|
|
1744
|
+
}
|
|
1745
|
+
/** @enumType */
|
|
1746
|
+
type PublishPluginConflictActionWithLiterals = PublishPluginConflictAction | 'FAIL_WHEN_PUBLISH_INSTALLED' | 'COPY_DRAFT_ITEMS_WITH_DRAFT_STATUS';
|
|
1747
|
+
interface AddDraftItemsPluginResponse {
|
|
1748
|
+
/** Updated data collection. */
|
|
1749
|
+
dataCollection?: DataCollection;
|
|
1750
|
+
}
|
|
1751
|
+
interface DeleteDraftItemsPluginRequest {
|
|
1752
|
+
/**
|
|
1753
|
+
* ID of the data collection to update.
|
|
1754
|
+
* @maxLength 256
|
|
1755
|
+
*/
|
|
1756
|
+
dataCollectionId: string;
|
|
1757
|
+
/** Action to take for existing draft items. */
|
|
1758
|
+
draftItemsRemovalAction?: DraftItemsRemovalActionWithLiterals;
|
|
1759
|
+
}
|
|
1760
|
+
/** Behavior to apply to existing draft items when removing the Draft Items plugin. */
|
|
1761
|
+
declare enum DraftItemsRemovalAction {
|
|
1762
|
+
/** Fail if draft items exist. */
|
|
1763
|
+
FAIL_IF_DRAFT_ITEMS_EXIST = "FAIL_IF_DRAFT_ITEMS_EXIST",
|
|
1764
|
+
/** Discard draft items, causing data loss. */
|
|
1765
|
+
DISCARD_EXISTING_DRAFT_ITEMS = "DISCARD_EXISTING_DRAFT_ITEMS",
|
|
1766
|
+
/** Publish draft items. This overwrites any currently published items with the same IDs. */
|
|
1767
|
+
PUBLISH_EXISTING_DRAFT_ITEMS = "PUBLISH_EXISTING_DRAFT_ITEMS"
|
|
1768
|
+
}
|
|
1769
|
+
/** @enumType */
|
|
1770
|
+
type DraftItemsRemovalActionWithLiterals = DraftItemsRemovalAction | 'FAIL_IF_DRAFT_ITEMS_EXIST' | 'DISCARD_EXISTING_DRAFT_ITEMS' | 'PUBLISH_EXISTING_DRAFT_ITEMS';
|
|
1771
|
+
interface DeleteDraftItemsPluginResponse {
|
|
1772
|
+
/** Updated data collection. */
|
|
1773
|
+
dataCollection?: DataCollection;
|
|
1774
|
+
}
|
|
1580
1775
|
interface PatchDataCollectionFieldRequest {
|
|
1581
1776
|
/**
|
|
1582
1777
|
* ID of the data collection to update.
|
|
@@ -2463,6 +2658,168 @@ interface DeleteDataCollectionPluginOptions {
|
|
|
2463
2658
|
/** Plugin type to remove. */
|
|
2464
2659
|
pluginType: PluginTypeWithLiterals;
|
|
2465
2660
|
}
|
|
2661
|
+
/**
|
|
2662
|
+
* Adds the Publish plugin to a data collection.
|
|
2663
|
+
* @param dataCollectionId - ID of the data collection to update.
|
|
2664
|
+
* @internal
|
|
2665
|
+
* @documentationMaturity preview
|
|
2666
|
+
* @requiredField dataCollectionId
|
|
2667
|
+
* @requiredField options.publishOptions
|
|
2668
|
+
* @permissionId data:v2:data_collection:add_publish_plugin
|
|
2669
|
+
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddPublishPlugin
|
|
2670
|
+
*/
|
|
2671
|
+
declare function addPublishPlugin(dataCollectionId: string, options?: NonNullablePaths<AddPublishPluginOptions, `publishOptions`, 2>): Promise<NonNullablePaths<AddPublishPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes`, 7>>;
|
|
2672
|
+
interface AddPublishPluginOptions {
|
|
2673
|
+
/** Publish plugin options. */
|
|
2674
|
+
publishOptions: PublishPluginOptions;
|
|
2675
|
+
/** Action to take when the Draft Items plugin is already installed. */
|
|
2676
|
+
draftItemsPluginConflictAction?: DraftItemsPluginConflictActionWithLiterals;
|
|
2677
|
+
}
|
|
2678
|
+
/**
|
|
2679
|
+
* Removes the Publish plugin from a data collection.
|
|
2680
|
+
* @param dataCollectionId - ID of the data collection to update.
|
|
2681
|
+
* @internal
|
|
2682
|
+
* @documentationMaturity preview
|
|
2683
|
+
* @requiredField dataCollectionId
|
|
2684
|
+
* @permissionId data:v2:data_collection:delete_publish_plugin
|
|
2685
|
+
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeletePublishPlugin
|
|
2686
|
+
*/
|
|
2687
|
+
declare function deletePublishPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeletePublishPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes`, 7>>;
|
|
2688
|
+
/**
|
|
2689
|
+
* Adds the Urlized plugin to a data collection.
|
|
2690
|
+
* @param dataCollectionId - ID of the data collection to update.
|
|
2691
|
+
* @internal
|
|
2692
|
+
* @documentationMaturity preview
|
|
2693
|
+
* @requiredField dataCollectionId
|
|
2694
|
+
* @requiredField options
|
|
2695
|
+
* @requiredField options.urlizedOptions
|
|
2696
|
+
* @permissionId data:v2:data_collection:add_urlized_plugin
|
|
2697
|
+
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddUrlizedPlugin
|
|
2698
|
+
*/
|
|
2699
|
+
declare function addUrlizedPlugin(dataCollectionId: string, options: NonNullablePaths<AddUrlizedPluginOptions, `urlizedOptions`, 2>): Promise<NonNullablePaths<AddUrlizedPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes`, 7>>;
|
|
2700
|
+
interface AddUrlizedPluginOptions {
|
|
2701
|
+
/** Urlized plugin options. */
|
|
2702
|
+
urlizedOptions: UrlizedPluginOptions;
|
|
2703
|
+
}
|
|
2704
|
+
/**
|
|
2705
|
+
* Removes the Urlized plugin from a data collection.
|
|
2706
|
+
* @param dataCollectionId - ID of the data collection to update.
|
|
2707
|
+
* @internal
|
|
2708
|
+
* @documentationMaturity preview
|
|
2709
|
+
* @requiredField dataCollectionId
|
|
2710
|
+
* @permissionId data:v2:data_collection:delete_urlized_plugin
|
|
2711
|
+
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteUrlizedPlugin
|
|
2712
|
+
*/
|
|
2713
|
+
declare function deleteUrlizedPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteUrlizedPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes`, 7>>;
|
|
2714
|
+
/**
|
|
2715
|
+
* Adds the Multilingual plugin to a data collection.
|
|
2716
|
+
* @param dataCollectionId - ID of the data collection to update.
|
|
2717
|
+
* @internal
|
|
2718
|
+
* @documentationMaturity preview
|
|
2719
|
+
* @requiredField dataCollectionId
|
|
2720
|
+
* @requiredField options
|
|
2721
|
+
* @requiredField options.multilingualOptions
|
|
2722
|
+
* @permissionId data:v2:data_collection:add_multilingual_plugin
|
|
2723
|
+
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddMultilingualPlugin
|
|
2724
|
+
*/
|
|
2725
|
+
declare function addMultilingualPlugin(dataCollectionId: string, options: NonNullablePaths<AddMultilingualPluginOptions, `multilingualOptions`, 2>): Promise<NonNullablePaths<AddMultilingualPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes`, 7>>;
|
|
2726
|
+
interface AddMultilingualPluginOptions {
|
|
2727
|
+
/** Multilingual plugin options. */
|
|
2728
|
+
multilingualOptions: MultilingualOptions;
|
|
2729
|
+
}
|
|
2730
|
+
/**
|
|
2731
|
+
* Removes the Multilingual plugin from a data collection.
|
|
2732
|
+
* @param dataCollectionId - ID of the data collection to update.
|
|
2733
|
+
* @internal
|
|
2734
|
+
* @documentationMaturity preview
|
|
2735
|
+
* @requiredField dataCollectionId
|
|
2736
|
+
* @permissionId data:v2:data_collection:delete_multilingual_plugin
|
|
2737
|
+
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteMultilingualPlugin
|
|
2738
|
+
*/
|
|
2739
|
+
declare function deleteMultilingualPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteMultilingualPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes`, 7>>;
|
|
2740
|
+
/**
|
|
2741
|
+
* Adds the CMS plugin to a data collection.
|
|
2742
|
+
* @param dataCollectionId - ID of the data collection to update.
|
|
2743
|
+
* @internal
|
|
2744
|
+
* @documentationMaturity preview
|
|
2745
|
+
* @requiredField dataCollectionId
|
|
2746
|
+
* @requiredField options
|
|
2747
|
+
* @requiredField options.cmsOptions
|
|
2748
|
+
* @permissionId data:v2:data_collection:add_cms_plugin
|
|
2749
|
+
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddCmsPlugin
|
|
2750
|
+
*/
|
|
2751
|
+
declare function addCmsPlugin(dataCollectionId: string, options: NonNullablePaths<AddCmsPluginOptions, `cmsOptions`, 2>): Promise<NonNullablePaths<AddCmsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes`, 7>>;
|
|
2752
|
+
interface AddCmsPluginOptions {
|
|
2753
|
+
/** CMS plugin options. */
|
|
2754
|
+
cmsOptions: PluginCmsOptions;
|
|
2755
|
+
}
|
|
2756
|
+
/**
|
|
2757
|
+
* Removes the CMS plugin from a data collection.
|
|
2758
|
+
* @param dataCollectionId - ID of the data collection to update.
|
|
2759
|
+
* @internal
|
|
2760
|
+
* @documentationMaturity preview
|
|
2761
|
+
* @requiredField dataCollectionId
|
|
2762
|
+
* @permissionId data:v2:data_collection:delete_cms_plugin
|
|
2763
|
+
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteCmsPlugin
|
|
2764
|
+
*/
|
|
2765
|
+
declare function deleteCmsPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteCmsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes`, 7>>;
|
|
2766
|
+
/**
|
|
2767
|
+
* Adds the Catalog plugin to a data collection.
|
|
2768
|
+
* @param dataCollectionId - ID of the data collection to update.
|
|
2769
|
+
* @internal
|
|
2770
|
+
* @documentationMaturity preview
|
|
2771
|
+
* @requiredField dataCollectionId
|
|
2772
|
+
* @requiredField options
|
|
2773
|
+
* @requiredField options.catalogOptions
|
|
2774
|
+
* @permissionId data:v2:data_collection:add_catalog_plugin
|
|
2775
|
+
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddCatalogPlugin
|
|
2776
|
+
*/
|
|
2777
|
+
declare function addCatalogPlugin(dataCollectionId: string, options: NonNullablePaths<AddCatalogPluginOptions, `catalogOptions`, 2>): Promise<NonNullablePaths<AddCatalogPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes`, 7>>;
|
|
2778
|
+
interface AddCatalogPluginOptions {
|
|
2779
|
+
/** Catalog plugin options. */
|
|
2780
|
+
catalogOptions: CatalogOptions;
|
|
2781
|
+
}
|
|
2782
|
+
/**
|
|
2783
|
+
* Removes the Catalog plugin from a data collection.
|
|
2784
|
+
* @param dataCollectionId - ID of the data collection to update.
|
|
2785
|
+
* @internal
|
|
2786
|
+
* @documentationMaturity preview
|
|
2787
|
+
* @requiredField dataCollectionId
|
|
2788
|
+
* @permissionId data:v2:data_collection:delete_catalog_plugin
|
|
2789
|
+
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteCatalogPlugin
|
|
2790
|
+
*/
|
|
2791
|
+
declare function deleteCatalogPlugin(dataCollectionId: string): Promise<NonNullablePaths<DeleteCatalogPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes`, 7>>;
|
|
2792
|
+
/**
|
|
2793
|
+
* Adds the Draft Items plugin to a data collection.
|
|
2794
|
+
* @param dataCollectionId - ID of the data collection to update.
|
|
2795
|
+
* @internal
|
|
2796
|
+
* @documentationMaturity preview
|
|
2797
|
+
* @requiredField dataCollectionId
|
|
2798
|
+
* @requiredField options.draftItemsOptions
|
|
2799
|
+
* @permissionId data:v2:data_collection:add_draft_items_plugin
|
|
2800
|
+
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddDraftItemsPlugin
|
|
2801
|
+
*/
|
|
2802
|
+
declare function addDraftItemsPlugin(dataCollectionId: string, options?: NonNullablePaths<AddDraftItemsPluginOptions, `draftItemsOptions`, 2>): Promise<NonNullablePaths<AddDraftItemsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes`, 7>>;
|
|
2803
|
+
interface AddDraftItemsPluginOptions {
|
|
2804
|
+
/** Draft Items plugin options. */
|
|
2805
|
+
draftItemsOptions: DraftItemsPluginOptions;
|
|
2806
|
+
/** Action to take when the Publish plugin is already installed. */
|
|
2807
|
+
publishPluginConflictAction?: PublishPluginConflictActionWithLiterals;
|
|
2808
|
+
}
|
|
2809
|
+
/**
|
|
2810
|
+
* Removes the Draft Items plugin from a data collection.
|
|
2811
|
+
* @param dataCollectionId - ID of the data collection to update.
|
|
2812
|
+
* @internal
|
|
2813
|
+
* @documentationMaturity preview
|
|
2814
|
+
* @requiredField dataCollectionId
|
|
2815
|
+
* @permissionId data:v2:data_collection:delete_draft_items_plugin
|
|
2816
|
+
* @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteDraftItemsPlugin
|
|
2817
|
+
*/
|
|
2818
|
+
declare function deleteDraftItemsPlugin(dataCollectionId: string, options?: DeleteDraftItemsPluginOptions): Promise<NonNullablePaths<DeleteDraftItemsPluginResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes`, 7>>;
|
|
2819
|
+
interface DeleteDraftItemsPluginOptions {
|
|
2820
|
+
/** Action to take for existing draft items. */
|
|
2821
|
+
draftItemsRemovalAction?: DraftItemsRemovalActionWithLiterals;
|
|
2822
|
+
}
|
|
2466
2823
|
/**
|
|
2467
2824
|
* Updates specified properties in a [data collection's](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/create-data-collection) `fields` array.
|
|
2468
2825
|
*
|
|
@@ -2480,4 +2837,4 @@ interface DeleteDataCollectionPluginOptions {
|
|
|
2480
2837
|
*/
|
|
2481
2838
|
declare function patchDataCollectionField(dataCollectionId: string, field: Field): Promise<NonNullablePaths<PatchDataCollectionFieldResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes`, 7>>;
|
|
2482
2839
|
|
|
2483
|
-
export { AccessLevel, type AccessLevelWithLiterals, type AccountInfo, type ActionEvent, type AddDataCollectionPluginOptions, type AddDataCollectionPluginRequest, type AddDataCollectionPluginResponse, type Address, type AllowedDataPermissions, type AllowedDraftPermissions, type AppOptions, type ApplicationError, type ArrayDocument, type ArraySizeRange, type ArrayString, type Audio, type BulkGetDataCollectionsPageBySnapshotsRequest, type BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf, type BulkGetDataCollectionsPageBySnapshotsResponse, type BulkGetDataCollectionsRequest, type BulkGetDataCollectionsResponse, type Calculator, type CalculatorPatternOneOf, type CatalogOptions, type CategoryFieldOptions, type CmsOptions, type CollectionCapabilities, type CollectionDefinition, CollectionOperation, type CollectionOperationWithLiterals, CollectionType, type CollectionTypeWithLiterals, type CreateAppCollectionsSnapshotRequest, type CreateAppCollectionsSnapshotResponse, type CreateDataCollectionFieldOptions, type CreateDataCollectionFieldRequest, type CreateDataCollectionFieldResponse, type CreateDataCollectionRequest, type CreateDataCollectionResponse, type CreateDataCollectionsSnapshotRequest, type CreateDataCollectionsSnapshotResponse, type CreateMigratedCollectionsSnapshotRequest, type CreateMigratedCollectionsSnapshotResponse, type DataCollection, type DataCollectionChangedEvent, type DataCollectionClonedEvent, type DataCollectionEvictedEvent, DataOperation, type DataOperationWithLiterals, type DataPermissions, type Datetime, type DatetimeDefaultValueOneOf, type DatetimeMaxDateOneOf, type DatetimeMinDateOneOf, type DeleteDataCollectionFieldOptions, type DeleteDataCollectionFieldRequest, type DeleteDataCollectionFieldResponse, type DeleteDataCollectionPluginOptions, type DeleteDataCollectionPluginRequest, type DeleteDataCollectionPluginResponse, type DeleteDataCollectionRequest, type DeleteDataCollectionResponse, type DeleteDataCollectionsSnapshotRequest, type DeleteDataCollectionsSnapshotResponse, type Destination, Direction, type DirectionWithLiterals, type Document, type DomainEvent, type DomainEventBodyOneOf, type DraftItemsPluginOptions, type DraftItemsPluginOptionsPairedCollectionOneOf, type DraftPermissions, type Email, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EnumValues, type FailedCollection, type Failure, type Field, type FieldCapabilities, type FieldCondition, type FieldPlugin, type FieldPluginOptionsOneOf, FieldPluginType, type FieldPluginTypeWithLiterals, type FieldRangeValidationsOneOf, type FieldUpdate, type FieldsPattern, Format, type FormatWithLiterals, type GetDataCollectionOptions, type GetDataCollectionRequest, type GetDataCollectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type Image, type Index, type IndexField, type IndexLimits, type IndexQuotaLimits, IndexSource, type IndexSourceWithLiterals, IndexStatus, type IndexStatusWithLiterals, type LegacyColor, type ListDataCollectionsOptions, type ListDataCollectionsRequest, type ListDataCollectionsResponse, type MediaGallery, type MessageEnvelope, type MultiReference, type MultilingualOptions, type NumberRange, type ObjectField, Order, type OrderWithLiterals, type PageLink, type PageLinkPluginOptions, PageLinkType, type PageLinkTypeWithLiterals, type Paging, type PagingMetadataV2, PagingMode, type PagingModeWithLiterals, type PatchDataCollection, type PatchDataCollectionFieldRequest, type PatchDataCollectionFieldResponse, type PatchDataCollectionRequest, type PatchDataCollectionResponse, Permission, type PermissionWithLiterals, type Permissions, type PermissionsUpdate, type Plugin, type PluginCmsOptions, type PluginOptionsOneOf, PluginType, type PluginTypeWithLiterals, type PluginUpdate, type PublishPluginOptions, QueryOperator, type QueryOperatorWithLiterals, type Reference, type RestorationCollection, type RestoreDataCollectionRequest, type RestoreDataCollectionResponse, type RestoreDataCollectionsFromSnapshotRequest, type RestoreDataCollectionsFromSnapshotResponse, type RestoreInfo, type RichContent, type RichText, Role, type RoleWithLiterals, Segment, type SegmentWithLiterals, type SingleItemPluginOptions, type SiteSort, type Slug, type SnapshotCollection, type Sort, SortOrder, type SortOrderWithLiterals, type Sorting, Status, type StatusWithLiterals, type StrictModeUpdate, type StringLengthRange, TenantMode, type TenantModeWithLiterals, type Text, type TextValidation, type TextValidationOneOf, type Time, Type, type TypeMetadata, type TypeMetadataMetadataOneOf, type TypeWithLiterals, type UpdateDataCollectionFieldOptions, type UpdateDataCollectionFieldRequest, type UpdateDataCollectionFieldResponse, type UpdateDataCollectionRequest, type UpdateDataCollectionResponse, type UpdateDataPermissionsRequest, type UpdateDataPermissionsResponse, type Url, type UrlizedOnlyPattern, type UrlizedPluginOptions, type Video, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type _Array, type _Boolean, type _Date, type _DateDefaultValueOneOf, type _DateMaxDateOneOf, type _DateMinDateOneOf, type _Number, type _Object, addDataCollectionPlugin, createDataCollection, createDataCollectionField, deleteDataCollection, deleteDataCollectionField, deleteDataCollectionPlugin, getDataCollection, listDataCollections, patchDataCollection, patchDataCollectionField, restoreDataCollection, updateDataCollection, updateDataCollectionField };
|
|
2840
|
+
export { AccessLevel, type AccessLevelWithLiterals, type AccountInfo, type ActionEvent, type AddCatalogPluginOptions, type AddCatalogPluginRequest, type AddCatalogPluginResponse, type AddCmsPluginOptions, type AddCmsPluginRequest, type AddCmsPluginResponse, type AddDataCollectionPluginOptions, type AddDataCollectionPluginRequest, type AddDataCollectionPluginResponse, type AddDraftItemsPluginOptions, type AddDraftItemsPluginRequest, type AddDraftItemsPluginResponse, type AddMultilingualPluginOptions, type AddMultilingualPluginRequest, type AddMultilingualPluginResponse, type AddPublishPluginOptions, type AddPublishPluginRequest, type AddPublishPluginResponse, type AddUrlizedPluginOptions, type AddUrlizedPluginRequest, type AddUrlizedPluginResponse, type Address, type AllowedDataPermissions, type AllowedDraftPermissions, type AppOptions, type ApplicationError, type ArrayDocument, type ArraySizeRange, type ArrayString, type Audio, type BulkGetDataCollectionsPageBySnapshotsRequest, type BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf, type BulkGetDataCollectionsPageBySnapshotsResponse, type BulkGetDataCollectionsRequest, type BulkGetDataCollectionsResponse, type Calculator, type CalculatorPatternOneOf, type CatalogOptions, type CategoryFieldOptions, type CmsOptions, type CollectionCapabilities, type CollectionDefinition, CollectionOperation, type CollectionOperationWithLiterals, CollectionType, type CollectionTypeWithLiterals, type CreateAppCollectionsSnapshotRequest, type CreateAppCollectionsSnapshotResponse, type CreateDataCollectionFieldOptions, type CreateDataCollectionFieldRequest, type CreateDataCollectionFieldResponse, type CreateDataCollectionRequest, type CreateDataCollectionResponse, type CreateDataCollectionsSnapshotRequest, type CreateDataCollectionsSnapshotResponse, type CreateMigratedCollectionsSnapshotRequest, type CreateMigratedCollectionsSnapshotResponse, type DataCollection, type DataCollectionChangedEvent, type DataCollectionClonedEvent, type DataCollectionEvictedEvent, DataOperation, type DataOperationWithLiterals, type DataPermissions, type Datetime, type DatetimeDefaultValueOneOf, type DatetimeMaxDateOneOf, type DatetimeMinDateOneOf, type DeleteCatalogPluginRequest, type DeleteCatalogPluginResponse, type DeleteCmsPluginRequest, type DeleteCmsPluginResponse, type DeleteDataCollectionFieldOptions, type DeleteDataCollectionFieldRequest, type DeleteDataCollectionFieldResponse, type DeleteDataCollectionPluginOptions, type DeleteDataCollectionPluginRequest, type DeleteDataCollectionPluginResponse, type DeleteDataCollectionRequest, type DeleteDataCollectionResponse, type DeleteDataCollectionsSnapshotRequest, type DeleteDataCollectionsSnapshotResponse, type DeleteDraftItemsPluginOptions, type DeleteDraftItemsPluginRequest, type DeleteDraftItemsPluginResponse, type DeleteMultilingualPluginRequest, type DeleteMultilingualPluginResponse, type DeletePublishPluginRequest, type DeletePublishPluginResponse, type DeleteUrlizedPluginRequest, type DeleteUrlizedPluginResponse, type Destination, Direction, type DirectionWithLiterals, type Document, type DomainEvent, type DomainEventBodyOneOf, DraftItemsPluginConflictAction, type DraftItemsPluginConflictActionWithLiterals, type DraftItemsPluginOptions, type DraftItemsPluginOptionsPairedCollectionOneOf, DraftItemsRemovalAction, type DraftItemsRemovalActionWithLiterals, type DraftPermissions, type Email, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EnumValues, type FailedCollection, type Failure, type Field, type FieldCapabilities, type FieldCondition, type FieldPlugin, type FieldPluginOptionsOneOf, FieldPluginType, type FieldPluginTypeWithLiterals, type FieldRangeValidationsOneOf, type FieldUpdate, type FieldsPattern, Format, type FormatWithLiterals, type GetDataCollectionOptions, type GetDataCollectionRequest, type GetDataCollectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type Image, type Index, type IndexField, type IndexLimits, type IndexQuotaLimits, IndexSource, type IndexSourceWithLiterals, IndexStatus, type IndexStatusWithLiterals, type LegacyColor, LifecycleStatus, type LifecycleStatusWithLiterals, type ListDataCollectionsOptions, type ListDataCollectionsRequest, type ListDataCollectionsResponse, type MediaGallery, type MessageEnvelope, type MultiReference, type MultilingualOptions, type NumberRange, type ObjectField, Order, type OrderWithLiterals, type PageLink, type PageLinkPluginOptions, PageLinkType, type PageLinkTypeWithLiterals, type Paging, type PagingMetadataV2, PagingMode, type PagingModeWithLiterals, type PatchDataCollection, type PatchDataCollectionFieldRequest, type PatchDataCollectionFieldResponse, type PatchDataCollectionRequest, type PatchDataCollectionResponse, Permission, type PermissionWithLiterals, type Permissions, type PermissionsUpdate, type Plugin, type PluginCmsOptions, type PluginOptionsOneOf, PluginType, type PluginTypeWithLiterals, type PluginUpdate, PublishPluginConflictAction, type PublishPluginConflictActionWithLiterals, type PublishPluginOptions, QueryOperator, type QueryOperatorWithLiterals, type Reference, type RestorationCollection, type RestoreDataCollectionRequest, type RestoreDataCollectionResponse, type RestoreDataCollectionsFromSnapshotRequest, type RestoreDataCollectionsFromSnapshotResponse, type RestoreInfo, type RichContent, type RichText, Role, type RoleWithLiterals, Segment, type SegmentWithLiterals, type SingleItemPluginOptions, type SiteSort, type Slug, type SnapshotCollection, type Sort, SortOrder, type SortOrderWithLiterals, type Sorting, Status, type StatusWithLiterals, type StrictModeUpdate, type StringLengthRange, TenantMode, type TenantModeWithLiterals, type Text, type TextValidation, type TextValidationOneOf, type Time, Type, type TypeMetadata, type TypeMetadataMetadataOneOf, type TypeWithLiterals, type UpdateDataCollectionFieldOptions, type UpdateDataCollectionFieldRequest, type UpdateDataCollectionFieldResponse, type UpdateDataCollectionRequest, type UpdateDataCollectionResponse, type UpdateDataPermissionsRequest, type UpdateDataPermissionsResponse, type Url, type UrlizedOnlyPattern, type UrlizedPluginOptions, type Video, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type _Array, type _Boolean, type _Date, type _DateDefaultValueOneOf, type _DateMaxDateOneOf, type _DateMinDateOneOf, type _Number, type _Object, addCatalogPlugin, addCmsPlugin, addDataCollectionPlugin, addDraftItemsPlugin, addMultilingualPlugin, addPublishPlugin, addUrlizedPlugin, createDataCollection, createDataCollectionField, deleteCatalogPlugin, deleteCmsPlugin, deleteDataCollection, deleteDataCollectionField, deleteDataCollectionPlugin, deleteDraftItemsPlugin, deleteMultilingualPlugin, deletePublishPlugin, deleteUrlizedPlugin, getDataCollection, listDataCollections, patchDataCollection, patchDataCollectionField, restoreDataCollection, updateDataCollection, updateDataCollectionField };
|