@wix/data 1.0.145 → 1.0.147

package/type-bundles/meta.bundle.d.ts

@@ -2187,11 +2187,26 @@ interface InsertDataItemRequest$1 {
     dataCollectionId: string;
     /** Item to insert. */
     dataItem: DataItem$1;
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
 }
 interface InsertDataItemResponse$1 {
     /** Inserted data item. */
     dataItem?: DataItem$1;
 }
+interface DataPublishPluginOptions$1 {
+    /**
+     * Whether to include draft items.
+     * When `true`, the response includes both published and draft items. Default: `false`.
+     */
+    includeDraftItems?: boolean;
+}
 interface BulkDataItemResult$1 {
     /** The action attempted for the data item. */
     action?: BulkActionType$1;
@@ -2236,6 +2251,19 @@ interface UpdateDataItemRequest$1 {
     dataCollectionId: string;
     /** Updated data item content. The existing data item's content is replaced entirely. */
     dataItem: DataItem$1;
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions$1;
 }
 interface UpdateDataItemResponse$1 {
     /** Updated data item. */
@@ -2246,6 +2274,19 @@ interface SaveDataItemRequest$1 {
     dataCollectionId: string;
     /** Data item to insert or update. */
     dataItem: DataItem$1;
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions$1;
 }
 interface SaveDataItemResponse$1 {
     /**
@@ -2289,6 +2330,19 @@ interface GetDataItemRequest$1 {
      * **Note:** The `_id` system field is always returned.
      */
     fields?: string[];
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions$1;
 }
 interface GetDataItemResponse$1 {
     /** Retrieved item. */
@@ -2299,6 +2353,19 @@ interface RemoveDataItemRequest$1 {
     dataCollectionId: string;
     /** ID of the item to remove. */
     dataItemId: string;
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions$1;
 }
 interface RemoveDataItemResponse$1 {
     /** Removed item. */
@@ -2346,6 +2413,19 @@ interface QueryDataItemsRequest$1 {
      * If not provided, result text is not translated.
      */
     language?: string | null;
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions$1;
     /** Options for retrieving referenced items. */
     referencedItemOptions?: ReferencedItemOptions$1[];
 }
@@ -2491,6 +2571,19 @@ interface AggregateDataItemsRequest$1 extends AggregateDataItemsRequestPagingMet
      * If not provided, result text is not translated.
      */
     language?: string | null;
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions$1;
 }
 /** @oneof */
 interface AggregateDataItemsRequestPagingMethodOneOf$1 {
@@ -2588,6 +2681,19 @@ interface CountDataItemsRequest$1 {
      * If not provided, result text is not translated.
      */
     language?: string | null;
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions$1;
 }
 interface CountDataItemsResponse$1 {
     /** Number of items matching the query. */
@@ -2640,6 +2746,11 @@ interface QueryDistinctValuesRequest$1 extends QueryDistinctValuesRequestPagingM
      * If not provided, result text is not translated.
      */
     language?: string | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions$1;
 }
 /** @oneof */
 interface QueryDistinctValuesRequestPagingMethodOneOf$1 {
@@ -2666,6 +2777,14 @@ interface BulkInsertDataItemsRequest$1 {
      * Default: `false`
      */
     returnEntity?: boolean;
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
 }
 interface BulkInsertDataItemsResponse$1 {
     /** Information about the inserted items. */
@@ -2685,6 +2804,19 @@ interface BulkUpdateDataItemsRequest$1 {
      * Default: `false`
      */
     returnEntity?: boolean;
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions$1;
 }
 interface BulkUpdateDataItemsResponse$1 {
     /** Information about the updated items. */
@@ -2704,6 +2836,19 @@ interface BulkSaveDataItemsRequest$1 {
      * Default: `false`
      */
     returnEntity?: boolean;
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions$1;
 }
 interface BulkSaveDataItemsResponse$1 {
     /** Information about the saved items. */
@@ -2716,6 +2861,19 @@ interface BulkRemoveDataItemsRequest$1 {
     dataCollectionId: string;
     /** IDs of data items to remove. */
     dataItemIds: string[];
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions$1;
 }
 interface BulkRemoveDataItemsResponse$1 {
     /** Information about the removed data items. */
@@ -2764,6 +2922,19 @@ interface QueryReferencedDataItemsRequest$1 extends QueryReferencedDataItemsRequ
      * **Note:** The `_id` system field is always returned.
      */
     fields?: string[];
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions$1;
 }
 /** @oneof */
 interface QueryReferencedDataItemsRequestPagingMethodOneOf$1 {
@@ -2824,6 +2995,14 @@ interface InsertDataItemReferenceRequest$1 {
     dataCollectionId: string;
     /** Reference to insert */
     dataItemReference?: DataItemReference$1;
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
 }
 interface DataItemReference$1 {
     /** Referring item field containing the references to the referenced items. */
@@ -3031,11 +3210,26 @@ interface InsertDataItemRequest {
     dataCollectionId: string;
     /** Item to insert. */
     dataItem: DataItem;
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
 }
 interface InsertDataItemResponse {
     /** Inserted data item. */
     dataItem?: DataItem;
 }
+interface DataPublishPluginOptions {
+    /**
+     * Whether to include draft items.
+     * When `true`, the response includes both published and draft items. Default: `false`.
+     */
+    includeDraftItems?: boolean;
+}
 interface BulkDataItemResult {
     /**
      * The action attempted for the data item.
@@ -3084,6 +3278,19 @@ interface UpdateDataItemRequest {
     dataCollectionId: string;
     /** Updated data item content. The existing data item's content is replaced entirely. */
     dataItem: DataItem;
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions;
 }
 interface UpdateDataItemResponse {
     /** Updated data item. */
@@ -3094,6 +3301,19 @@ interface SaveDataItemRequest {
     dataCollectionId: string;
     /** Data item to insert or update. */
     dataItem: DataItem;
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions;
 }
 interface SaveDataItemResponse {
     /**
@@ -3136,6 +3356,19 @@ interface GetDataItemRequest {
      * **Note:** The `_id` system field is always returned.
      */
     fields?: string[];
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions;
 }
 interface GetDataItemResponse {
     /** Retrieved item. */
@@ -3146,6 +3379,19 @@ interface RemoveDataItemRequest {
     dataCollectionId: string;
     /** ID of the item to remove. */
     dataItemId: string;
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions;
 }
 interface RemoveDataItemResponse {
     /** Removed item. */
@@ -3192,6 +3438,19 @@ interface QueryDataItemsRequest {
      * If not provided, result text is not translated.
      */
     language?: string | null;
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions;
     /** Options for retrieving referenced items. */
     referencedItemOptions?: ReferencedItemOptions[];
 }
@@ -3340,6 +3599,19 @@ interface AggregateDataItemsRequest extends AggregateDataItemsRequestPagingMetho
      * If not provided, result text is not translated.
      */
     language?: string | null;
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions;
 }
 /** @oneof */
 interface AggregateDataItemsRequestPagingMethodOneOf {
@@ -3436,6 +3708,19 @@ interface CountDataItemsRequest {
      * If not provided, result text is not translated.
      */
     language?: string | null;
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions;
 }
 interface CountDataItemsResponse {
     /** Number of items matching the query. */
@@ -3491,6 +3776,11 @@ interface QueryDistinctValuesRequest extends QueryDistinctValuesRequestPagingMet
      * If not provided, result text is not translated.
      */
     language?: string | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions;
 }
 /** @oneof */
 interface QueryDistinctValuesRequestPagingMethodOneOf {
@@ -3517,6 +3807,14 @@ interface BulkInsertDataItemsRequest {
      * Default: `false`
      */
     returnEntity?: boolean;
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
 }
 interface BulkInsertDataItemsResponse {
     /** Information about the inserted items. */
@@ -3536,6 +3834,19 @@ interface BulkUpdateDataItemsRequest {
      * Default: `false`
      */
     returnEntity?: boolean;
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions;
 }
 interface BulkUpdateDataItemsResponse {
     /** Information about the updated items. */
@@ -3555,6 +3866,19 @@ interface BulkSaveDataItemsRequest {
      * Default: `false`
      */
     returnEntity?: boolean;
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions;
 }
 interface BulkSaveDataItemsResponse {
     /** Information about the saved items. */
@@ -3567,6 +3891,19 @@ interface BulkRemoveDataItemsRequest {
     dataCollectionId: string;
     /** IDs of data items to remove. */
     dataItemIds: string[];
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions;
 }
 interface BulkRemoveDataItemsResponse {
     /** Information about the removed data items. */
@@ -3614,6 +3951,19 @@ interface QueryReferencedDataItemsRequest extends QueryReferencedDataItemsReques
      * **Note:** The `_id` system field is always returned.
      */
     fields?: string[];
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying:
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
+    /**
+     * Options for the Publish plugin.
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     */
+    publishPluginOptions?: DataPublishPluginOptions;
 }
 /** @oneof */
 interface QueryReferencedDataItemsRequestPagingMethodOneOf {
@@ -3673,6 +4023,14 @@ interface InsertDataItemReferenceRequest {
     dataCollectionId: string;
     /** Reference to insert */
     dataItemReference?: DataItemReference;
+    /**
+     * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+     *
+     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
+     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     */
+    appOptions?: Record<string, any> | null;
 }
 interface DataItemReference {
     /** Referring item field containing the references to the referenced items. */

package/type-bundles/service-plugins-context.bundle.d.ts

@@ -1056,21 +1056,79 @@ interface GetCapabilitiesEnvelope {
     metadata: Context;
 }
 declare const provideHandlers$1: ServicePluginDefinition<{
+    /**
+     *
+     * Retrieves a list of items based on the provided filtering, sorting, and paging preferences. */
     queryDataItems(payload: QueryDataItemsEnvelope): QueryDataItemsResponse | Promise<QueryDataItemsResponse>;
+    /**
+     * Counts the number of items in the specified data collection that match the filtering preferences. */
     countDataItems(payload: CountDataItemsEnvelope): CountDataItemsResponse | Promise<CountDataItemsResponse>;
+    /**
+     * Runs an aggregation query on the specified data collection and returns the resulting list of items. */
     aggregateDataItems(payload: AggregateDataItemsEnvelope): AggregateDataItemsResponse | Promise<AggregateDataItemsResponse>;
+    /**
+     *
+     * Retrieves a list of distinct values for a given field for all items that match the query, without duplicates.
+     *
+     * As with [`queryDataItems()`](/external-database/query-data-items), this function retrieves items based on the filtering, sorting, and paging preferences provided. However, this function does not return the full items that match the query. Rather, for items that match the query, it returns all unique values in the field specified in `fieldName`. If more than one item has the same value in that field, that value appears only once. */
     queryDistinctValues(payload: QueryDistinctValuesEnvelope): QueryDistinctValuesResponse | Promise<QueryDistinctValuesResponse>;
+    /**
+     *
+     * Adds one or more items to a collection.
+     *
+     * A data item object contains the `_id` and `_owner` fields. The response array must include the same items that were inserted, and each returned item must be added the `_createdDate` and `_updatedDate` fields.
+     *
+     * However, data items can also be inserted without an `_id` field. In that case, it is the service provider's responsibility to generate a unique ID for each item. */
     insertDataItems(payload: InsertDataItemsEnvelope): InsertDataItemsResponse | Promise<InsertDataItemsResponse>;
+    /**
+     *
+     * Updates one or more items in a collection. Items must be completely replaced.
+     *
+     * The response array must include the same items that were updated, and each returned item must be added the `_createdDate` and `_updatedDate` fields. */
     updateDataItems(payload: UpdateDataItemsEnvelope): UpdateDataItemsResponse | Promise<UpdateDataItemsResponse>;
+    /**
+     * Removes one or more items from a collection. The response object must contain the removed item. */
     removeDataItems(payload: RemoveDataItemsEnvelope): RemoveDataItemsResponse | Promise<RemoveDataItemsResponse>;
+    /**
+     * Removes all items from a collection. */
     truncateDataItems(payload: TruncateDataItemsEnvelope): TruncateDataItemsResponse | Promise<TruncateDataItemsResponse>;
+    /**
+     *
+     * Retrieves the items referenced in the specified field of a referring item. Reference fields refer to items that exist in different collections. Implement this function so callers can retrieve the full details of the referenced items.
+     *
+     * This service plugin supports item multi-references, which means that data collections can have many-to-many relationships with other collections. For example, consider a scenario where a **Movies** collection includes a multi-reference **Actors** field, which might refer to several **Actor** items in an **Actors** collection. Users can therefore query the **Movies** collection to retrieve the **Actor** items referenced in each **Movie** item.
+     *
+     * > **Notes:**
+     * > - This function does not retrieve the full referenced items of referenced items. For example, the referenced **Actors** collection might itself contain a multi-reference field with references to **Award** items in an **Awards** collection. When calling this function to retrieve the referenced items of any **Movie** item, the response contains the referenced **Actor** items, but only the IDs of the **Award** items. To retrieve the full **Award** items, the user must either call this function for the **Actors** collection, or the [`queryDataItems()`](/external-database/query-data-items) function for the **Awards** collection.
+     * > - This function might also be called when a user calls the [`isReferenced()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/is-referenced-data-item) function of the Data API. */
     queryReferencedDataItems(payload: QueryReferencedDataItemsEnvelope): QueryReferencedDataItemsResponse | Promise<QueryReferencedDataItemsResponse>;
+    /**
+     * Inserts one or more item references into a referring field of the specified item. */
     insertDataItemReferences(payload: InsertDataItemReferencesEnvelope): InsertDataItemReferencesResponse | Promise<InsertDataItemReferencesResponse>;
+    /**
+     * Removes one or more item references from a referring field of the specified item. */
     removeDataItemReferences(payload: RemoveDataItemReferencesEnvelope): RemoveDataItemReferencesResponse | Promise<RemoveDataItemReferencesResponse>;
+    /**
+     *
+     * Retrieves a list of data collections and their details.
+     *
+     * When `collectionIds` is empty, all existing collections are returned.
+     * If a specified collection does not exist, that collection can be ignored. */
     listCollections(payload: ListCollectionsEnvelope): ListCollectionsResponse | Promise<ListCollectionsResponse>;
+    /**
+     * Creates a new data collection. */
     createCollection(payload: CreateCollectionEnvelope): CreateCollectionResponse | Promise<CreateCollectionResponse>;
+    /**
+     *
+     * Updates the structure of an existing data collection.
+     *
+     * Some parameters, such as `capabilities` and `pagingMode`, are determined by the service provider. If the collection passed in the request contains these parameters, their values must be ignored. However, these fields must be included in the response collection with relevant values. */
     updateCollection(payload: UpdateCollectionEnvelope): UpdateCollectionResponse | Promise<UpdateCollectionResponse>;
+    /**
+     * Deletes a data collection. */
     deleteCollection(payload: DeleteCollectionEnvelope): DeleteCollectionResponse | Promise<DeleteCollectionResponse>;
+    /**
+     * Lists the global capabilities the external database supports. */
     getCapabilities(payload: GetCapabilitiesEnvelope): GetCapabilitiesResponse | Promise<GetCapabilitiesResponse>;
 }>;