@wix/auto_sdk_data_collections 1.0.104 → 1.0.106

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.
@@ -2408,6 +2408,59 @@ interface ListDataCollectionsOptions {
2408
2408
  */
2409
2409
  fields?: string[];
2410
2410
  }
2411
+ /**
2412
+ * Retrieves multiple data collections by ID.
2413
+ *
2414
+ * Starting on August 3rd, 2026, when called with a visitor (unauthenticated) identity, the returned collections
2415
+ * contain only the details needed to display the collections' data: `id`, `displayName`, `displayField`,
2416
+ * `plugins`, and for each field in `fields` its `key`, `displayName`, `type`, and `typeMetadata`. All other
2417
+ * collection details, such as `permissions` and `capabilities`, are omitted. Calls made with any other identity
2418
+ * return the full collections.
2419
+ * @public
2420
+ * @documentationMaturity preview
2421
+ * @permissionId WIX_DATA.BULK_GET_COLLECTIONS
2422
+ * @applicableIdentity APP
2423
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.BulkGetDataCollections
2424
+ */
2425
+ declare function bulkGetDataCollections(options?: BulkGetDataCollectionsOptions): Promise<NonNullablePaths<BulkGetDataCollectionsResponse, `activeCollections` | `activeCollections.${number}._id` | `activeCollections.${number}.collectionType` | `activeCollections.${number}.defaultDisplayOrder.fieldKey` | `activeCollections.${number}.defaultDisplayOrder.direction` | `activeCollections.${number}.capabilities.indexLimits.regular` | `activeCollections.${number}.capabilities.indexLimits.unique` | `activeCollections.${number}.capabilities.indexLimits.total` | `activeCollections.${number}.permissions.insert` | `activeCollections.${number}.permissions.update` | `activeCollections.${number}.permissions.remove` | `activeCollections.${number}.permissions.read` | `activeCollections.${number}.deprecation.deprecated` | `deletedCollections` | `deletedCollections.${number}._id` | `deletedCollections.${number}.collectionType` | `deletedCollections.${number}.defaultDisplayOrder.fieldKey` | `deletedCollections.${number}.defaultDisplayOrder.direction` | `deletedCollections.${number}.capabilities.indexLimits.regular` | `deletedCollections.${number}.capabilities.indexLimits.unique` | `deletedCollections.${number}.capabilities.indexLimits.total` | `deletedCollections.${number}.permissions.insert` | `deletedCollections.${number}.permissions.update` | `deletedCollections.${number}.permissions.remove` | `deletedCollections.${number}.permissions.read` | `deletedCollections.${number}.deprecation.deprecated` | `failedCollections` | `failedCollections.${number}.collectionId` | `failedCollections.${number}.error.code` | `failedCollections.${number}.error.description`, 4>>;
2426
+ interface BulkGetDataCollectionsOptions {
2427
+ /**
2428
+ * IDs of the collections to retrieve.
2429
+ * @minSize 1
2430
+ * @maxSize 100
2431
+ * @maxLength 256
2432
+ */
2433
+ dataCollectionIds?: string[];
2434
+ /**
2435
+ * Whether to include deleted collections.
2436
+ *
2437
+ * Default: `false`
2438
+ */
2439
+ showDeletedCollections?: boolean;
2440
+ /**
2441
+ * Whether the returned collection list should include referenced collections.
2442
+ *
2443
+ * Default: `false`
2444
+ */
2445
+ includeReferencedCollections?: boolean;
2446
+ /** Sorting preferences. */
2447
+ sort?: Sorting;
2448
+ /**
2449
+ * Whether to retrieve data from the primary database instance.
2450
+ * This decreases performance but ensures data retrieved is up to date even immediately after an update.
2451
+ * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
2452
+ *
2453
+ * Default: `false`
2454
+ */
2455
+ consistentRead?: boolean;
2456
+ /**
2457
+ * List of specific field names to return, if empty all fields are returned.
2458
+ * Affects all returned collections
2459
+ * @maxSize 100
2460
+ * @maxLength 1000
2461
+ */
2462
+ fields?: string[];
2463
+ }
2411
2464
  /**
2412
2465
  * Updates a data collection.
2413
2466
  *
@@ -2685,58 +2738,287 @@ interface DeleteDataCollectionPluginOptions {
2685
2738
  /** Plugin type to remove. */
2686
2739
  pluginType: PluginTypeWithLiterals;
2687
2740
  }
2741
+ /**
2742
+ * Adds the Publish plugin to a data collection.
2743
+ * @public
2744
+ * @documentationMaturity preview
2745
+ * @requiredField dataCollectionId
2746
+ * @requiredField options.publishOptions
2747
+ * @param dataCollectionId - ID of the data collection to update.
2748
+ * @param publishOptions - Publish plugin options.
2749
+ * @param options - Options for adding the Publish plugin.
2750
+ * @permissionId data:v2:data_collection:add_publish_plugin
2751
+ * @applicableIdentity APP
2752
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddPublishPlugin
2753
+ */
2754
+ declare function addPublishPlugin(dataCollectionId: string, options?: NonNullablePaths<AddPublishPluginOptions, `publishOptions`, 0>): 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` | `dataCollection.deprecation.deprecated`, 5>>;
2688
2755
  interface AddPublishPluginOptions {
2689
2756
  /** Publish plugin options. */
2690
2757
  publishOptions: PublishPluginOptions;
2691
2758
  /** Action to take when the Draft Items plugin is already installed. */
2692
2759
  draftItemsPluginConflictAction?: DraftItemsPluginConflictActionWithLiterals;
2693
2760
  }
2761
+ /**
2762
+ * Removes the Publish plugin from a data collection.
2763
+ * @param dataCollectionId - ID of the data collection to update.
2764
+ * @public
2765
+ * @documentationMaturity preview
2766
+ * @requiredField dataCollectionId
2767
+ * @permissionId data:v2:data_collection:delete_publish_plugin
2768
+ * @applicableIdentity APP
2769
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeletePublishPlugin
2770
+ */
2771
+ 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` | `dataCollection.deprecation.deprecated`, 5>>;
2772
+ /**
2773
+ * Updates the Publish plugin options on a data collection.
2774
+ * @param dataCollectionId - ID of the data collection to update.
2775
+ * @public
2776
+ * @documentationMaturity preview
2777
+ * @requiredField dataCollectionId
2778
+ * @requiredField options
2779
+ * @requiredField options.publishOptions
2780
+ * @permissionId data:v2:data_collection:update_publish_plugin
2781
+ * @applicableIdentity APP
2782
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdatePublishPlugin
2783
+ */
2784
+ declare function updatePublishPlugin(dataCollectionId: string, options: NonNullablePaths<UpdatePublishPluginOptions, `publishOptions`, 0>): Promise<NonNullablePaths<UpdatePublishPluginResponse, `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` | `dataCollection.deprecation.deprecated`, 5>>;
2694
2785
  interface UpdatePublishPluginOptions {
2695
2786
  /** Updated Publish plugin options. Read-only fields are ignored. */
2696
2787
  publishOptions: PublishPluginOptions;
2697
2788
  }
2789
+ /**
2790
+ * Adds the Urlized plugin to a data collection.
2791
+ * @public
2792
+ * @documentationMaturity preview
2793
+ * @requiredField dataCollectionId
2794
+ * @requiredField options
2795
+ * @requiredField options.urlizedOptions
2796
+ * @param dataCollectionId - ID of the data collection to update.
2797
+ * @param urlizedOptions - Urlized plugin options.
2798
+ * @permissionId data:v2:data_collection:add_urlized_plugin
2799
+ * @applicableIdentity APP
2800
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddUrlizedPlugin
2801
+ */
2802
+ declare function addUrlizedPlugin(dataCollectionId: string, options: NonNullablePaths<AddUrlizedPluginOptions, `urlizedOptions`, 0>): 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` | `dataCollection.deprecation.deprecated`, 5>>;
2698
2803
  interface AddUrlizedPluginOptions {
2699
2804
  /** Urlized plugin options. */
2700
2805
  urlizedOptions: UrlizedPluginOptions;
2701
2806
  }
2807
+ /**
2808
+ * Removes the Urlized plugin from a data collection.
2809
+ * @param dataCollectionId - ID of the data collection to update.
2810
+ * @public
2811
+ * @documentationMaturity preview
2812
+ * @requiredField dataCollectionId
2813
+ * @permissionId data:v2:data_collection:delete_urlized_plugin
2814
+ * @applicableIdentity APP
2815
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteUrlizedPlugin
2816
+ */
2817
+ 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` | `dataCollection.deprecation.deprecated`, 5>>;
2818
+ /**
2819
+ * Updates the Urlized plugin options on a data collection.
2820
+ * @param dataCollectionId - ID of the data collection to update.
2821
+ * @public
2822
+ * @documentationMaturity preview
2823
+ * @requiredField dataCollectionId
2824
+ * @requiredField options
2825
+ * @requiredField options.urlizedOptions
2826
+ * @permissionId data:v2:data_collection:update_urlized_plugin
2827
+ * @applicableIdentity APP
2828
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateUrlizedPlugin
2829
+ */
2830
+ declare function updateUrlizedPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateUrlizedPluginOptions, `urlizedOptions`, 0>): Promise<NonNullablePaths<UpdateUrlizedPluginResponse, `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` | `dataCollection.deprecation.deprecated`, 5>>;
2702
2831
  interface UpdateUrlizedPluginOptions {
2703
2832
  /** Updated Urlized plugin options. */
2704
2833
  urlizedOptions: UrlizedPluginOptions;
2705
2834
  }
2835
+ /**
2836
+ * Adds the Multilingual plugin to a data collection.
2837
+ * @public
2838
+ * @documentationMaturity preview
2839
+ * @requiredField dataCollectionId
2840
+ * @requiredField options
2841
+ * @requiredField options.multilingualOptions
2842
+ * @param dataCollectionId - ID of the data collection to update.
2843
+ * @param multilingualOptions - Multilingual plugin options.
2844
+ * @permissionId data:v2:data_collection:add_multilingual_plugin
2845
+ * @applicableIdentity APP
2846
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddMultilingualPlugin
2847
+ */
2848
+ declare function addMultilingualPlugin(dataCollectionId: string, options: NonNullablePaths<AddMultilingualPluginOptions, `multilingualOptions`, 0>): 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` | `dataCollection.deprecation.deprecated`, 5>>;
2706
2849
  interface AddMultilingualPluginOptions {
2707
2850
  /** Multilingual plugin options. */
2708
2851
  multilingualOptions: MultilingualOptions;
2709
2852
  }
2853
+ /**
2854
+ * Removes the Multilingual plugin from a data collection.
2855
+ * @param dataCollectionId - ID of the data collection to update.
2856
+ * @public
2857
+ * @documentationMaturity preview
2858
+ * @requiredField dataCollectionId
2859
+ * @permissionId data:v2:data_collection:delete_multilingual_plugin
2860
+ * @applicableIdentity APP
2861
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteMultilingualPlugin
2862
+ */
2863
+ 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` | `dataCollection.deprecation.deprecated`, 5>>;
2864
+ /**
2865
+ * Updates the Multilingual plugin options on a data collection.
2866
+ * @param dataCollectionId - ID of the data collection to update.
2867
+ * @public
2868
+ * @documentationMaturity preview
2869
+ * @requiredField dataCollectionId
2870
+ * @requiredField options
2871
+ * @requiredField options.multilingualOptions
2872
+ * @permissionId data:v2:data_collection:update_multilingual_plugin
2873
+ * @applicableIdentity APP
2874
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateMultilingualPlugin
2875
+ */
2876
+ declare function updateMultilingualPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateMultilingualPluginOptions, `multilingualOptions`, 0>): Promise<NonNullablePaths<UpdateMultilingualPluginResponse, `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` | `dataCollection.deprecation.deprecated`, 5>>;
2710
2877
  interface UpdateMultilingualPluginOptions {
2711
2878
  /** Updated Multilingual plugin options. */
2712
2879
  multilingualOptions: MultilingualOptions;
2713
2880
  }
2881
+ /**
2882
+ * Adds the CMS plugin to a data collection.
2883
+ * @public
2884
+ * @documentationMaturity preview
2885
+ * @requiredField dataCollectionId
2886
+ * @requiredField options
2887
+ * @requiredField options.cmsOptions
2888
+ * @param dataCollectionId - ID of the data collection to update.
2889
+ * @param cmsOptions - CMS plugin options.
2890
+ * @permissionId data:v2:data_collection:add_cms_plugin
2891
+ * @applicableIdentity APP
2892
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddCmsPlugin
2893
+ */
2894
+ declare function addCmsPlugin(dataCollectionId: string, options: NonNullablePaths<AddCmsPluginOptions, `cmsOptions`, 0>): 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` | `dataCollection.deprecation.deprecated`, 5>>;
2714
2895
  interface AddCmsPluginOptions {
2715
2896
  /** CMS plugin options. */
2716
2897
  cmsOptions: PluginCmsOptions;
2717
2898
  }
2899
+ /**
2900
+ * Removes the CMS plugin from a data collection.
2901
+ * @param dataCollectionId - ID of the data collection to update.
2902
+ * @public
2903
+ * @documentationMaturity preview
2904
+ * @requiredField dataCollectionId
2905
+ * @permissionId data:v2:data_collection:delete_cms_plugin
2906
+ * @applicableIdentity APP
2907
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteCmsPlugin
2908
+ */
2909
+ 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` | `dataCollection.deprecation.deprecated`, 5>>;
2910
+ /**
2911
+ * Updates the CMS plugin options on a data collection.
2912
+ * @param dataCollectionId - ID of the data collection to update.
2913
+ * @public
2914
+ * @documentationMaturity preview
2915
+ * @requiredField dataCollectionId
2916
+ * @requiredField options
2917
+ * @requiredField options.cmsOptions
2918
+ * @permissionId data:v2:data_collection:update_cms_plugin
2919
+ * @applicableIdentity APP
2920
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateCmsPlugin
2921
+ */
2922
+ declare function updateCmsPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateCmsPluginOptions, `cmsOptions`, 0>): Promise<NonNullablePaths<UpdateCmsPluginResponse, `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` | `dataCollection.deprecation.deprecated`, 5>>;
2718
2923
  interface UpdateCmsPluginOptions {
2719
2924
  /** Updated CMS plugin options. */
2720
2925
  cmsOptions: PluginCmsOptions;
2721
2926
  }
2927
+ /**
2928
+ * Adds the Catalog plugin to a data collection.
2929
+ * @public
2930
+ * @documentationMaturity preview
2931
+ * @requiredField dataCollectionId
2932
+ * @requiredField options
2933
+ * @requiredField options.catalogOptions
2934
+ * @param dataCollectionId - ID of the data collection to update.
2935
+ * @param catalogOptions - Catalog plugin options.
2936
+ * @permissionId data:v2:data_collection:add_catalog_plugin
2937
+ * @applicableIdentity APP
2938
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddCatalogPlugin
2939
+ */
2940
+ declare function addCatalogPlugin(dataCollectionId: string, options: NonNullablePaths<AddCatalogPluginOptions, `catalogOptions`, 0>): 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` | `dataCollection.deprecation.deprecated`, 5>>;
2722
2941
  interface AddCatalogPluginOptions {
2723
2942
  /** Catalog plugin options. */
2724
2943
  catalogOptions: CatalogOptions;
2725
2944
  }
2945
+ /**
2946
+ * Removes the Catalog plugin from a data collection.
2947
+ * @param dataCollectionId - ID of the data collection to update.
2948
+ * @public
2949
+ * @documentationMaturity preview
2950
+ * @requiredField dataCollectionId
2951
+ * @permissionId data:v2:data_collection:delete_catalog_plugin
2952
+ * @applicableIdentity APP
2953
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteCatalogPlugin
2954
+ */
2955
+ 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` | `dataCollection.deprecation.deprecated`, 5>>;
2956
+ /**
2957
+ * Updates the Catalog plugin options on a data collection.
2958
+ * @param dataCollectionId - ID of the data collection to update.
2959
+ * @public
2960
+ * @documentationMaturity preview
2961
+ * @requiredField dataCollectionId
2962
+ * @requiredField options
2963
+ * @requiredField options.catalogOptions
2964
+ * @permissionId data:v2:data_collection:update_catalog_plugin
2965
+ * @applicableIdentity APP
2966
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateCatalogPlugin
2967
+ */
2968
+ declare function updateCatalogPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateCatalogPluginOptions, `catalogOptions`, 0>): Promise<NonNullablePaths<UpdateCatalogPluginResponse, `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` | `dataCollection.deprecation.deprecated`, 5>>;
2726
2969
  interface UpdateCatalogPluginOptions {
2727
2970
  /** Updated Catalog plugin options. */
2728
2971
  catalogOptions: CatalogOptions;
2729
2972
  }
2973
+ /**
2974
+ * Adds the Draft Items plugin to a data collection.
2975
+ * @public
2976
+ * @documentationMaturity preview
2977
+ * @requiredField dataCollectionId
2978
+ * @requiredField options.draftItemsOptions
2979
+ * @param dataCollectionId - ID of the data collection to update.
2980
+ * @param draftItemsOptions - Draft Items plugin options.
2981
+ * @param options - Options for adding the Draft Items plugin.
2982
+ * @permissionId data:v2:data_collection:add_draft_items_plugin
2983
+ * @applicableIdentity APP
2984
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.AddDraftItemsPlugin
2985
+ */
2986
+ declare function addDraftItemsPlugin(dataCollectionId: string, options?: NonNullablePaths<AddDraftItemsPluginOptions, `draftItemsOptions`, 0>): 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` | `dataCollection.deprecation.deprecated`, 5>>;
2730
2987
  interface AddDraftItemsPluginOptions {
2731
2988
  /** Draft Items plugin options. */
2732
2989
  draftItemsOptions: DraftItemsPluginOptions;
2733
2990
  /** Action to take when the Publish plugin is already installed. */
2734
2991
  publishPluginConflictAction?: PublishPluginConflictActionWithLiterals;
2735
2992
  }
2993
+ /**
2994
+ * Removes the Draft Items plugin from a data collection.
2995
+ * @param dataCollectionId - ID of the data collection to update.
2996
+ * @public
2997
+ * @documentationMaturity preview
2998
+ * @requiredField dataCollectionId
2999
+ * @param options - Options for removing the Draft Items plugin.
3000
+ * @permissionId data:v2:data_collection:delete_draft_items_plugin
3001
+ * @applicableIdentity APP
3002
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.DeleteDraftItemsPlugin
3003
+ */
3004
+ 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` | `dataCollection.deprecation.deprecated`, 5>>;
2736
3005
  interface DeleteDraftItemsPluginOptions {
2737
3006
  /** Action to take for existing draft items. */
2738
3007
  draftItemsRemovalAction?: DraftItemsRemovalActionWithLiterals;
2739
3008
  }
3009
+ /**
3010
+ * Updates the Draft Items plugin options on a data collection.
3011
+ * @param dataCollectionId - ID of the data collection to update.
3012
+ * @public
3013
+ * @documentationMaturity preview
3014
+ * @requiredField dataCollectionId
3015
+ * @requiredField options
3016
+ * @requiredField options.draftItemsOptions
3017
+ * @permissionId data:v2:data_collection:update_draft_items_plugin
3018
+ * @applicableIdentity APP
3019
+ * @fqn com.wixpress.cloud.data.api.collectionservice.DataCollectionService.UpdateDraftItemsPlugin
3020
+ */
3021
+ declare function updateDraftItemsPlugin(dataCollectionId: string, options: NonNullablePaths<UpdateDraftItemsPluginOptions, `draftItemsOptions`, 0>): Promise<NonNullablePaths<UpdateDraftItemsPluginResponse, `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` | `dataCollection.deprecation.deprecated`, 5>>;
2740
3022
  interface UpdateDraftItemsPluginOptions {
2741
3023
  /** Updated Draft Items plugin options. Read-only fields are ignored. */
2742
3024
  draftItemsOptions: DraftItemsPluginOptions;
@@ -2758,4 +3040,4 @@ interface UpdateDraftItemsPluginOptions {
2758
3040
  */
2759
3041
  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` | `dataCollection.deprecation.deprecated`, 5>>;
2760
3042
 
2761
- 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 Deprecation, 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 MediaImage, 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 UpdateCatalogPluginOptions, type UpdateCatalogPluginRequest, type UpdateCatalogPluginResponse, type UpdateCmsPluginOptions, type UpdateCmsPluginRequest, type UpdateCmsPluginResponse, type UpdateDataCollectionFieldOptions, type UpdateDataCollectionFieldRequest, type UpdateDataCollectionFieldResponse, type UpdateDataCollectionRequest, type UpdateDataCollectionResponse, type UpdateDataPermissionsRequest, type UpdateDataPermissionsResponse, type UpdateDraftItemsPluginOptions, type UpdateDraftItemsPluginRequest, type UpdateDraftItemsPluginResponse, type UpdateMultilingualPluginOptions, type UpdateMultilingualPluginRequest, type UpdateMultilingualPluginResponse, type UpdatePublishPluginOptions, type UpdatePublishPluginRequest, type UpdatePublishPluginResponse, type UpdateUrlizedPluginOptions, type UpdateUrlizedPluginRequest, type UpdateUrlizedPluginResponse, 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, updateDataCollection, updateDataCollectionField };
3043
+ 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 BulkGetDataCollectionsOptions, 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 Deprecation, 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 MediaImage, 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 UpdateCatalogPluginOptions, type UpdateCatalogPluginRequest, type UpdateCatalogPluginResponse, type UpdateCmsPluginOptions, type UpdateCmsPluginRequest, type UpdateCmsPluginResponse, type UpdateDataCollectionFieldOptions, type UpdateDataCollectionFieldRequest, type UpdateDataCollectionFieldResponse, type UpdateDataCollectionRequest, type UpdateDataCollectionResponse, type UpdateDataPermissionsRequest, type UpdateDataPermissionsResponse, type UpdateDraftItemsPluginOptions, type UpdateDraftItemsPluginRequest, type UpdateDraftItemsPluginResponse, type UpdateMultilingualPluginOptions, type UpdateMultilingualPluginRequest, type UpdateMultilingualPluginResponse, type UpdatePublishPluginOptions, type UpdatePublishPluginRequest, type UpdatePublishPluginResponse, type UpdateUrlizedPluginOptions, type UpdateUrlizedPluginRequest, type UpdateUrlizedPluginResponse, 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, bulkGetDataCollections, createDataCollection, createDataCollectionField, deleteCatalogPlugin, deleteCmsPlugin, deleteDataCollection, deleteDataCollectionField, deleteDataCollectionPlugin, deleteDraftItemsPlugin, deleteMultilingualPlugin, deletePublishPlugin, deleteUrlizedPlugin, getDataCollection, listDataCollections, patchDataCollection, patchDataCollectionField, updateCatalogPlugin, updateCmsPlugin, updateDataCollection, updateDataCollectionField, updateDraftItemsPlugin, updateMultilingualPlugin, updatePublishPlugin, updateUrlizedPlugin };