@wix/wix-data-items-sdk 1.0.529 → 1.0.531

package/build/es/src/data-v2-data-item-items.universal.d.ts

@@ -18,6 +18,10 @@ import { DataItemCreatedEnvelope, DataItemDeletedEnvelope, DataItemUpdatedEnvelo
  *
  * When inserting an item into a collection that has a reference field, set the
  * value of the reference field to the referenced item's `_id` value or the entire referenced item object.
+ * When inserting an item into a collection that has a multi-reference field, set the
+ * value of the multi-reference field to an array of the referenced items' `_id` values or an array of the
+ * entire referenced item objects.
+ * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
  *
  * The `insert()` method adds the following properties and values to the item
  * when it adds it to the collection:
@@ -37,7 +41,6 @@ import { DataItemCreatedEnvelope, DataItemDeletedEnvelope, DataItemUpdatedEnvelo
  * > - If an item's `_id` property value is set to `null` or an empty string, an error is thrown.
  * > - When creating a [single-item collection](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection), an item with the system field `_id` is pre-inserted into the collection. [Single-item collections](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection) may contain only one item.
  * > - If there is a pre-existing item in a [single-item collection](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection), the `insert()` method will not run. To update or change an item in a single-item collection see the `update()` and `save()` methods.
- * > - The `insert()` method does not support multi-reference fields. For  multi-reference fields, use `insertReference()`.
  * > - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `insert()` fails and issues an error.
  * @public
  * @param dataCollectionId - ID of the collection item belongs to.
@@ -76,12 +79,15 @@ export declare function insert<Item extends Record<string, any>>(dataCollectionI
  * When updating an item in a collection that has a reference field, set the
  * value of the reference field to the referenced item's `_id` value or the
  * entire referenced item object.
+ * When updating an item in a collection that has a multi-reference field, set the
+ * value of the multi-reference field to an array of the referenced items' `_id` values or an array of the
+ * entire referenced item objects.
+ * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
  *
  * The maximum size of an item that you can update in a collection is 500kb.
  *
  * > **Notes:**
  * > - The specified item must include an `_id` property that already exists in the collection.
- * > - The `update()` method does not support multi-reference fields. For multi-reference fields, use `replaceReferences()` or `insertReference()`.
  * > - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `update()` fails and issues an error.
  *
  * @param dataCollectionId - ID of the collection item belongs to.
@@ -120,11 +126,14 @@ export declare function update<Item extends WithId>(dataCollectionId: string, it
  * When saving an item to a collection that has a reference field, set the
  * value of the reference field to the referenced item's `_id` value or the
  * entire referenced item object.
+ * When saving an item to a collection that has a multi-reference field, set the
+ * value of the multi-reference field to an array of the referenced items' `_id` values or an array of the
+ * entire referenced item objects.
+ * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
  *
  * > **Notes:**
  * > - The maximum size of an item that you can save to a collection is 500kb.
  * > - If an item's `_id` property value is set to null or an empty string, an error is thrown.
- * > - The `save()` method does not support multi-reference fields. For multi-reference fields, use `insertReference() `or `replaceReferences()`.
  * > - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `save()` fails and issues an error.
  *
  * @public
@@ -232,6 +241,10 @@ export declare function truncate(dataCollectionId: string): Promise<void>;
  * When inserting items into a collection that has a reference field, set the
  * values of the reference fields to the referenced item's `_id` value or the
  * entire referenced item object.
+ * When inserting items into a collection that has a multi-reference field, set the
+ * values of the multi-reference fields to arrays of the referenced items' `_id` values or arrays of the
+ * entire referenced item objects.
+ * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
  *
  * The `bulkInsert()` method adds the following properties and values to the
  * item when it adds it to the collection:
@@ -254,7 +267,6 @@ export declare function truncate(dataCollectionId: string): Promise<void>;
  * > - If an item's `_id` property value is set to `null` or an empty string, an error is thrown.
  * > - Bulk operations are limited to 1000 items per method call.
  * > - The `bulkInsert()` method is not supported for [single-item collections](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection).
- * > - The `bulkInsert()` method does not support multi-reference fields. For multi-reference fields, use `insertReference()`.
  * > - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `bulkInsert()` fails and issues an error.
  * @public
  * @documentationMaturity preview
@@ -296,11 +308,14 @@ export declare function bulkInsert<Item extends Record<string, any>>(dataCollect
  * When updating items in a collection that has a reference field, set the
  * values of the reference field to the referenced item's `_id` value or the
  * entire referenced item object.
+ * When updating items in a collection that has a multi-reference field, set the
+ * values of the multi-reference field to arrays of the referenced items' `_id` values or arrays of the
+ * entire referenced item objects.
+ * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
  *
  * > **Notes:**
  * > - The maximum size of an item that you can update in a collection is 500kb.
  * > - Bulk operations are limited to 1000 items per method call.
- * > - The `bulkUpdate()` method does not support multi-reference fields. For multi-reference fields, use `replaceReferences()` or `insertReference()`.
  * > - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `bulkUpdate()` fails and issues an error.
  *
  * @public
@@ -340,13 +355,16 @@ export declare function bulkUpdate<Item extends WithId>(dataCollectionId: string
  * When saving items to a collection that has a reference field, set the values
  * of the reference fields to the referenced item's `_id` value or the entire
  * referenced item object.
+ * When saving items to a collection that has a multi-reference field, set the
+ * values of the multi-reference fields to arrays of the referenced items' `_id` values or arrays of the
+ * entire referenced item objects.
+ * To save multi-reference values, pass `saveReferences: true` in the `options` argument.
  *
  * > **Notes:**
  * > - The maximum size of an item that you can save to a collection is 500kb.
  * > - If an item's `_id` property value is set to null or an empty string, an error is thrown.
  * > - Bulk operations are limited to 1000 items per method call.
  * > - The `bulkSave()` method is not supported for [single-item collections](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection).
- * > - The `bulkSave()` method does not support multi-reference fields. For multi-reference fields, use `replaceReferences()` or `insertReference()`.
  * > - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `bulkSave()` fails and issues an error.
  *
  * @public
@@ -497,13 +515,9 @@ export declare function removeReference<ItemLeft extends WithId, ItemRight exten
  * @fqn com.wixpress.cloud.data.api.data.DataItemService.ReplaceDataItemReferences
  */
 export declare function replaceReferences<ItemLeft extends WithId, ItemRight extends WithId>(dataCollectionId: string, field: string, referringItem: ItemLeft | string, referencedItem: ItemRight | string | ItemRight[] | string[], options?: WixDataOptions): Promise<void>;
+export declare function patch(dataCollectionId: string, itemId: string): WixDataPatch;
 /**
- * Creates a patch to modify the specified item. Unlike [`update()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/update), only the fields specified in the request are modified. Data that isn't explicitly modified remains unchanged.
- *
- *
- * The `patch()` method builds a patch to modify a data item in a specified collection. It returns a `WixDataPatch` object that contains the patch definition, which you can further refine by chaining [`WixDataPatch`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-patch/introduction) methods onto it. These methods allow you to clear, set, and increment field values, as well as add or remove items from array fields. The methods are applied in the order in which they are chained.
- *
- * Finally, to run the patch, chain [`run()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-patch/run) as the last method.
+ * Partially updates the specified item. Unlike [`update()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/update), only the fields specified in the request are modified. Data that isn't explicitly modified remains unchanged.
  *
  * If an item is found in the specified collection with the specified ID, that item is patched. If the collection doesn't contain an item with that ID, the request fails.
  *
@@ -512,25 +526,25 @@ export declare function replaceReferences<ItemLeft extends WithId, ItemRight ext
  * > **Notes**:
  * > - When an item is patched, its `data._updatedDate` property is updated to the current date and time.
  * > - You can only patch items in [collections created by Wix users](https://support.wix.com/en/article/cms-formerly-content-manager-creating-a-collection). Items in [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code) cannot be patched.
+ * > - Multi-reference fields are supported. You can use APPEND_TO_ARRAY field modification to add new references, REMOVE_FROM_ARRAY to remove references, and SET_FIELD to replace the current references.
  *
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
  * @requiredField itemId
+ * @requiredField fieldModifications
  * @param dataCollectionId - ID of the collection that contains the item to patch.
  * @param itemId - ID of the data item to patch.
+ * @param fieldModifications - An array of field modifications to apply when patching the item.
+ * @param options - Options to use when processing this operation.
  * @permissionScope Write Data Items
  * @permissionScopeId SCOPE.DC-DATA.WRITE
  * @fqn com.wixpress.cloud.data.api.data.DataItemService.PatchDataItem
  */
-export declare function patch(dataCollectionId: string, itemId: string): WixDataPatch;
 export declare function patch<Item extends Record<string, any> = WixDataItem>(dataCollectionId: string, itemId: string, fieldModifications: FieldModification[], options?: WixDataPatchOptions): Promise<(Item & WixDataItem) | null>;
+export declare function bulkPatch(dataCollectionId: string, itemIds: string[]): WixDataBulkPatch;
 /**
- * Creates a bulk patch to modify the specified items. Unlike [`bulkUpdate()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/bulk-update), only the fields specified in the request are modified. Data that isn't explicitly modified remains unchanged.
- *
- * The `bulkPatch()` method builds a bulk patch to modify multiple data items in a collection. It returns a `WixDataBulkPatch` object that contains the bulk patch definition, which you can further refine by chaining [`WixDataBulkPatch`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-bulk-patch/introduction) methods onto it. These methods allow you to clear, set, and increment field values, as well as add or remove items from array fields. The methods are applied in the order in which they are chained.
- *
- * Finally, to run the bulk patch, chain [`run()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-bulk-patch/run) as the last method.
+ * Partially updates a number of items in a collection. Unlike [`bulkUpdate()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/bulk-update), only the fields specified in the request are modified. Data that isn't explicitly modified remains unchanged.
  *
  * Calling the `bulkPatch()` method triggers the [`beforeUpdate()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/before-update) and [`afterUpdate()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/after-update) hooks for each patched item, if the hooks have been defined.
  *
@@ -541,26 +555,26 @@ export declare function patch<Item extends Record<string, any> = WixDataItem>(da
  * > - When an item is patched, its `data._updatedDate` field is updated to the current date and time.
  * > - The maximum size of a patched collection item is 500kb.
  * > - If an item ID isn't found, the `errors` array in the response returned by [`run()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-bulk-patch/run) contains a corresponding item with details about the error. Learn more about [Wix Data Error Codes](https://dev.wix.com/docs/sdk/backend-modules/data/wix-data-error-codes).
- *
+ * > - Multi-reference fields are supported. You can use APPEND_TO_ARRAY field modification to add new references, REMOVE_FROM_ARRAY to remove references, and SET_FIELD to replace the current references.
  *
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
  * @requiredField itemIds
+ * @requiredField fieldModifications
  * @param dataCollectionId - ID of the collection that contains the items to patch.
  * @param itemIds - IDs of the data items to patch.
+ * @param fieldModifications - An array of field modifications to apply when patching the items.
+ * @param options - Options to use when processing this operation.
  * @permissionScope Write Data Items
  * @permissionScopeId SCOPE.DC-DATA.WRITE
  * @fqn com.wixpress.cloud.data.api.data.DataItemService.BulkPatchDataItems
  */
-export declare function bulkPatch(dataCollectionId: string, itemIds: string[]): WixDataBulkPatch;
 export declare function bulkPatch(dataCollectionId: string, itemIds: string[], fieldModifications: FieldModification[], options?: WixDataBulkPatchOptions): Promise<WixDataBulkResult>;
 /**
  * Creates an async patch to modify all items matching a filter.
  *
- * The `asyncPatchByFilter()` method builds an async patch operation that selects items by filter instead of item ID.
- * It returns a `WixDataPatchByFilter` object that you can refine with patch methods such as `setField()`,
- * `removeField()`, `incrementField()`, `appendToArray()`, and `removeFromArray()`. To start the job, chain `run()`.
+ * The `asyncPatchByFilter()` method selects items by filter and starts a background job to partially update them.
  *
  * Pass an empty filter object to patch all items in the collection.
  *
@@ -568,9 +582,11 @@ export declare function bulkPatch(dataCollectionId: string, itemIds: string[], f
  * @documentationMaturity preview
  * @requiredField dataCollectionId
  * @requiredField filter
+ * @requiredField fieldModifications
  * @param dataCollectionId - ID of the collection containing the items to patch.
  * @param filter - Filter selecting items to patch. Use `{}` to select all items.
  * @param fieldModifications - Field modifications to apply to the items.
+ * @param options - Options to use when processing this operation.
  * @permissionScope Write Data Items
  * @permissionScopeId SCOPE.DC-DATA.WRITE
  * @fqn com.wixpress.cloud.data.api.data.DataItemService.AsyncPatchDataItemsByFilter
@@ -608,67 +624,35 @@ export declare function asyncRemoveByFilter(dataCollectionId: string, filter: Wi
  * @fqn com.wixpress.cloud.data.api.data.DataItemService.GetAsyncJobStatus
  */
 export declare function getAsyncJobStatus(jobId: string): Promise<WixDataAsyncJobStatus>;
+export declare function query(dataCollectionId: string): WixDataQuery;
 /**
- * Creates a query to retrieve items from a database collection.
- *
- * The `query()` method builds a query to retrieve data items from a collection and returns a `WixDataQuery` object, which contains the query definition. You can refine the query by chaining [`WixDataQuery` methods](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-query/introduction) onto the query. `WixDataQuery` methods enable you to sort, filter, and control the query results.
- *
- *
- * The methods chained to `query()` are applied in the order they are called. For example, if you sort by an `age` field in ascending order and then by a `name` field in descending order, the results are sorted first by the age of the items. If there are multiple results with the same age, they are further sorted by name in descending order, per age value.
- *
- * Finally, to run the query, chain [`find()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-query/find) or [`distinct()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-query/distinct) as the last method.
- *
- * The `query()` method runs with the following `WixDataQuery` defaults that you can override:
- * - `skip`: `0`
- * - `limit`: `50`
- * - `descending`: by `_createdDate`
- * - `include`: `none`
+ * Retrieves items using a query from a database collection.
  *
  * > **Notes**:
  * > - When calling `query()` immediately following an update to your collection, the data retrieved might not contain the most recent changes. If you need the most up-to-date data, set the `options.consistentRead` parameter of the [`find()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-query/find) or [`distinct()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-query/distinct) methods to `true`. Learn more about [Wix Data and eventual consistency](https://dev.wix.com/docs/sdk/backend-modules/data/eventual-consistency).
  * > - To speed up data retrieval, the results of certain data queries are cached. Learn more about [caching data query results](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/data-api/about-caching-data-query-results).
  * > - Items marked [in the CMS as hidden](https://support.wix.com/en/article/cms-controlling-live-site-item-visibility-from-your-collection) are not retrieved.
- * > - If the collection that you are querying has references to other collections, by default the data from referenced collections is not retrieved. To retrieve data from the referenced items, specify them using the `include()` method.
+ * > - If the collection that you are querying has references to other collections, by default the data from referenced collections is not retrieved. To retrieve data from the referenced items, use `includeReferences` option.
  * > - When querying [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code), make sure the fields you use to refine your query support the intended operations. Learn more about [querying by Wix app collection fields](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-app-collections/querying-wix-app-collections).
  *
  *
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
+ * @requiredField queryRequest
  * @param dataCollectionId - ID of the collection to run the query on.
+ * @param queryRequest - Query request object that defines the filter, sorting, selected fields, and paging for the collection query.
+ * @param options - Options to use when processing this operation.
+ * @returns Promise that resolves to the query results.
  * @permissionScope Read Data Items
  * @permissionScopeId SCOPE.DC-DATA.READ
  * @applicableIdentity APP
  * @fqn com.wixpress.cloud.data.api.data.DataItemService.QueryDataItems
  */
-/**
- * Creates a query on a data collection.
- * @param dataCollectionId - ID of the collection to run the query on.
- * @returns A `WixDataQuery` builder object.
- */
-export declare function query(dataCollectionId: string): WixDataQuery;
-/**
- * Executes a query directly on a data collection.
- * @internal
- * @param dataCollectionId - ID of the collection to run the query on.
- * @param queryRequest - Query parameters including filter, sort, limit, skip, fields, and include.
- * @param options - Options for running the query.
- * @returns Promise that resolves to the query results.
- */
 export declare function query<Item extends Record<string, any> = WixDataItem>(dataCollectionId: string, queryRequest: WixDataQueryRequest, options?: WixDataQueryOptions): Promise<WixDataQueryResponse<Item & WixDataItem>>;
+export declare function search(dataCollectionId: string): WixDataSearch;
 /**
- * Creates a search operation to find items in a database collection.
- *
- * The `search()` method builds a search operation to find data items in the specified collection based on text search and filter criteria. It returns a [`WixDataSearch`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-search/introduction) object that defines the search operation, which you can refine by chaining [`WixDataSearch`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-search/introduction) methods onto it. These methods define the search expression and mode, apply filters, and control sorting and pagination of search results.
- *
- * The methods chained to `search()` are applied in the order they are called. For example, if you specify an expression, apply filters, and then sort by a field, the search first finds items that match the expression and filters, and then sorts the results.
- *
- * Finally, to run the search, chain [`run()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-search/run) as the last method.
- *
- * The `search()` method runs with the following [`WixDataSearch`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-search/introduction) defaults that you can override:
- * - `skip`: `0`
- * - `limit`: `100`
- * - `ascending`: by `_id`
+ * Searches for items in a database collection.
  *
  * > **Notes**:
  * > - Search operations are [eventually consistent](https://dev.wix.com/docs/sdk/backend-modules/data/eventual-consistency) and might not reflect recent changes.
@@ -677,81 +661,48 @@ export declare function query<Item extends Record<string, any> = WixDataItem>(da
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
+ * @requiredField searchRequest
  * @param dataCollectionId - ID of the collection in which to run the search.
- * @permissionScope Read Data Items
- * @permissionScopeId SCOPE.DC-DATA.READ
- */
-export declare function search(dataCollectionId: string): WixDataSearch;
-/**
- * Executes a search directly on a data collection.
- * @internal
- * @param dataCollectionId - ID of the collection to run the search on.
- * @param searchRequest - Search parameters including expression, mode, filter, sort, and paging.
- * @param options - Options for running the search.
+ * @param searchRequest - Search request object that defines the search expression, filter, sorting, selected fields, and paging to use when searching a collection.
  * @returns Promise that resolves to the search results.
- */
-export declare function search<Item extends Record<string, any> = WixDataItem>(dataCollectionId: string, searchRequest: WixDataSearchRequest, options?: WixDataSearchOptions): Promise<WixDataSearchResponse<Item & WixDataItem>>;
-/**
- * Creates an aggregation on a data collection.
- *
- * The `aggregate()` method builds an aggregation on the specified collection and returns a `WixDataAggregate` object.
- *
- * An aggregation enables you to perform certain calculations on your collection data, or on groups of items that you define, to retrieve meaningful summaries.
- *
- * You can also add paging, filtering, and sorting preferences to your aggregation by chaining [`WixDataAggregate`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate/introduction) methods. The returned object contains the aggregate definition.
- *
- * Finally, to run the aggregation, chain [`run()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate/run) as the last method.
- *
- * The `aggregate()` method runs with the following defaults that you can override:
- *
- *  + `skip`: `0`
- *  + `limit`: `50`
- *
- * @public
- * @documentationMaturity preview
- * @requiredField dataCollectionId
- * @param dataCollectionId - ID of the collection to run the aggregation on.
  * @permissionScope Read Data Items
  * @permissionScopeId SCOPE.DC-DATA.READ
- * @applicableIdentity APP
- * @fqn com.wixpress.cloud.data.api.data.DataItemService.AggregateDataItems
  */
+export declare function search<Item extends Record<string, any> = WixDataItem>(dataCollectionId: string, searchRequest: WixDataSearchRequest, options?: WixDataSearchOptions): Promise<WixDataSearchResponse<Item & WixDataItem>>;
 export declare function aggregate(dataCollectionId: string): WixDataAggregate;
-/**
- * Executes an aggregation pipeline directly on a data collection.
- * @internal
- * @param dataCollectionId - ID of the collection to run the aggregation on.
- * @param pipeline - Aggregation pipeline with stages and paging.
- * @param options - Options for running the aggregation.
- * @returns Promise that resolves to the aggregation results.
- */
-export declare function aggregate<Result extends Record<string, any> = Record<string, any>>(dataCollectionId: string, pipeline: AggregationPipeline, options?: WixDataAggregateOptions): Promise<WixDataAggregateResponse<Result>>;
 /**
  * Runs an aggregation pipeline on a data collection and returns the results.
  *
- * Aggregations enable you to perform advanced data calculations, transformations, and groupings. While [`aggregate()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/aggregate) allows you to perform basic aggregations, `aggregatePipeline()` allows you to perform advanced aggregations sequentially in stages, with each stage transforming the results of the previous stage.
+ * Aggregations enable you to perform advanced data calculations, transformations, and groupings. Aggregations are perfomed sequentially in stages, with each stage transforming the results of the previous stage.
  *
- * When calling the `aggregatePipeline()` method, specify the collection ID and an aggregation pipeline. To build the pipeline, call the [`pipelineBuilder()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder) method and chain [`PipelineBuilder`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder/introduction) methods to add stages and configure paging.
+ * When calling the `aggregate()` method, specify the collection ID and an aggregation pipeline. To build the pipeline, call the [`PipelineBuilder()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder) method and chain [`PipelineBuilder`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder/introduction) methods to add stages and configure paging.
  *
- * `aggregatePipeline()` returns the aggregated results and pagination information.
+ * `aggregate()` returns the aggregated results and pagination information.
  *
  * > **Note**: You can only build an aggregation pipeline for collections [created in the CMS](https://support.wix.com/en/article/cms-formerly-content-manager-creating-a-collection) or with the [Data Collections API](https://dev.wix.com/docs/sdk/backend-modules/data/collections/introduction). They cannot be used on [Wix app collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) or [external collections](https://dev.wix.com/docs/develop-websites/articles/databases/external-databases/overview/integrating-external-databases-with-your-wix-site).
  *
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
+ * @requiredField pipeline
  * @param dataCollectionId - ID of the collection to run the aggregation pipeline on.
- * @param pipeline - Aggregation pipeline with data processing stages and paging configuration. Call [`pipelineBuilder()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder) to build the pipeline.
+ * @param pipeline - Aggregation pipeline with data processing stages and paging configuration. Call [`PipelineBuilder()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder) to build the pipeline.
  * @param options - Options for running the aggregation pipeline.
+ * @returns Promise that resolves to the aggregation results.
  * @permissionScope Read Data Items
  * @permissionScopeId SCOPE.DC-DATA.READ
  * @applicableIdentity APP
  * @fqn com.wixpress.cloud.data.api.data.DataItemService.AggregatePipelineDataItems
  */
+export declare function aggregate<Result extends Record<string, any> = Record<string, any>>(dataCollectionId: string, pipeline: AggregationPipeline, options?: WixDataAggregateOptions): Promise<WixDataAggregateResponse<Result>>;
 export declare function aggregatePipeline(dataCollectionId: string, pipeline: AggregationPipeline, options?: WixDataAggregateOptions): Promise<AggregatePipelineDataItemsResponse>;
 /**
  * Retrieves distinct values for a specified field directly from a data collection.
- * @internal
+ *
+ * @public
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
+ * @requiredField fieldName
  * @param dataCollectionId - ID of the collection to retrieve distinct values from.
  * @param fieldName - Field whose distinct values are retrieved.
  * @param options - Options for running the distinct operation.
@@ -760,24 +711,27 @@ export declare function aggregatePipeline(dataCollectionId: string, pipeline: Ag
 export declare function distinct<Value = any>(dataCollectionId: string, fieldName: string, options?: WixDataDistinctOptions): Promise<WixDataDistinctResponse<Value>>;
 /**
  * Counts the number of items directly in a data collection.
- * @internal
+ *
+ * @public
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
  * @param dataCollectionId - ID of the collection to count items in.
  * @param options - Options for running the count.
  * @returns Promise that resolves to the number of items.
  */
 export declare function count(dataCollectionId: string, options?: WixDataCountOptions): Promise<number>;
+export declare function queryReferenced(dataCollectionId: string, referringItem: WixDataItem | string, field: string, options?: WixDataQueryReferencedOptions): Promise<WixDataResult>;
 /**
  * Retrieves the full items referenced in the specified field of an item.
  *
  * Reference and multi-reference fields refer to items in different collections. Use this method to retrieve the full details of the referenced items.
  *
- * For example, suppose you have a **Movies** collection with an **Actors** field that contains references to items in a **People** collection. Querying the **Movies** collection using `queryReferenced()` retrieves the relevant **People** items referenced in the **Actors** field of the specified **Movie** item. This gives you information from the **People** collection about each of the actors in the specified movie.
+ * For example, suppose you have a **Movies** collection with an **Actors** field that contains references to items in a **People** collection. Querying the **Movies** collection using `queryReferencedItems()` retrieves the relevant **People** items referenced in the **Actors** field of the specified **Movie** item. This gives you information from the **People** collection about each of the actors in the specified movie.
  *
- * The `queryReferenced()` method returns a Promise that resolves to the full items referenced in the specified property of the item from the specified collection. The Promise is rejected if the current user does not have read permissions for the specified collection or the collection containing the referenced items.
+ * The `queryReferencedItems()` method returns a Promise that resolves to the full items referenced in the specified property of the item from the specified collection. The Promise is rejected if the current user does not have read permissions for the specified collection or the collection containing the referenced items.
  *
  * > **Notes**:
- * > - You can only call `queryReferenced()` for [multi-reference fields](https://support.wix.com/en/article/about-referencing-multiple-items-in-one-field).
- * > - This method does not support [single-item collections](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection).
+ * > - You can call `queryReferencedItems()` for both [reference](https://support.wix.com/en/article/cms-using-reference-fields-to-display-content-from-multiple-collections) and [multi-reference](https://support.wix.com/en/article/about-referencing-multiple-items-in-one-field) fields.
  * > - When calling `queryReferenced()` immediately following an update to your collection, the data retrieved [may not contain the most recent changes](https://dev.wix.com/docs/sdk/backend-modules/data/eventual-consistency). If you need the most up-to-date data, set `options.consistentRead` to `true`.
  * > - To speed up data retrieval, the results of certain data queries are cached. Learn more about [caching data query results](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/data-api/about-caching-data-query-results).
  *
@@ -788,23 +742,6 @@ export declare function count(dataCollectionId: string, options?: WixDataCountOp
  * @requiredField referringItem
  * @requiredField field
  * @param dataCollectionId - ID of the collection that contains the referring item.
- * @param referringItem - Referring item or referring item's ID.
- * @param field - Field that contains the references to the referenced items.
- * @param options - Options for querying referenced data items.
- * @permissionScope Read Data Items
- * @permissionScopeId SCOPE.DC-DATA.READ
- * @applicableIdentity APP
- * @fqn com.wixpress.cloud.data.api.data.DataItemService.QueryReferencedDataItems
- */
-export declare function queryReferenced(dataCollectionId: string, referringItem: WixDataItem | string, field: string, options?: WixDataQueryReferencedOptions): Promise<WixDataResult>;
-/**
- * Queries referenced items for one or more referring items.
- * @internal
- * @documentationMaturity preview
- * @requiredField dataCollectionId
- * @requiredField referringItem
- * @requiredField field
- * @param dataCollectionId - ID of the collection that contains the referring item.
  * @param referringItem - Referring item, referring item's ID, or a list of referring items or IDs.
  * @param field - Field that contains the references to the referenced items.
  * @param options - Options for querying referenced data items.
@@ -814,16 +751,6 @@ export declare function queryReferenced(dataCollectionId: string, referringItem:
  * @fqn com.wixpress.cloud.data.api.data.DataItemService.QueryReferencedDataItems
  */
 export declare function queryReferencedItems<Item extends Record<string, any> = WixDataItem>(dataCollectionId: string, referringItem: WixDataItem | string | (WixDataItem | string)[], field: string, options?: WixDataQueryReferencedItemsOptions): Promise<WixDataQueryReferencedItemsResponse<Item & WixDataItem>>;
-/**
- * Creates a filter for queries and aggregations.
- *
- * The `filter()` method builds a filter to be applied to a query or an aggregation. It returns a `WixDataFilter` object, which can be used with other filter methods such as `and()`, `or()` and `not()`, to create complex filter definitions.
- *
- * When working with [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code), check which fields can be used in a filter.
- *
- * @public
- * @documentationMaturity preview
- */
 export declare function filter(): WixDataFilter;
 /**
  * Sets the [collection environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing) for any methods chained to it.
@@ -889,11 +816,33 @@ export { WixDataReadOptions, WixDataReadWithProjectionOptions, WithIncludeFieldG
 /** @builder */
 export interface PipelineBuilder extends _PipelineBuilder {
 }
-/** @hidden */
+/**
+ * Builds an aggregation pipeline for use with [`aggregate()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/aggregate).
+ *
+ * Configure the pipeline by calling `PipelineBuilder()` and chaining [`PipelineBuilder`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder/introduction) methods. Then, specify the pipeline as the `pipeline` parameter when calling the [`aggregate()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/aggregate) method.
+ *
+ * > **Note**: You can only build an aggregation pipeline for collections [created in the CMS](https://support.wix.com/en/article/cms-formerly-content-manager-creating-a-collection) or with the [Data Collections API](https://dev.wix.com/docs/sdk/backend-modules/data/collections/introduction). They cannot be used on [Wix app collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) or [external collections](https://dev.wix.com/docs/develop-websites/articles/databases/external-databases/overview/integrating-external-databases-with-your-wix-site).
+ *
+ * @public
+ * @documentationMaturity preview
+ * @returns PipelineBuilder object
+ */
 export declare const PipelineBuilder: () => _PipelineBuilder;
-/** @hidden */
+/**
+ * Use `Stages` to create and configure pipeline stages such as `filter()`,
+ * `group()`, `project()`, `sort()`, `limit()`, `skip()`, `unwind()`, and
+ * `objectToArray()` when building an aggregation pipeline.
+ *
+ * @public
+ * @documentationMaturity preview
+ */
 export declare const Stages: WixDataAggregatePipelineStages;
-/** @hidden */
+/**
+ * Use `Expressions` to build computed values for aggregation stages such as
+ * `project()`, `group()`, and `reshape()`.
+ * @public
+ * @documentationMaturity preview
+ */
 export declare const Expressions: WixDataAggregatePipelineExpressions;
 export { PagingMetadata, WixDataQueryRequest } from '@wix/wix-data-items-common';
 export type { WixDataIsReferencedOptions, WixDataGetOptionsBuilder, WixDataQueryOptionsBuilder, WixDataQueryReferencedItemsOptionsBuilder, WixDataAggregateOptionsBuilder, WixDataDistinctOptionsBuilder, WixDataCountOptionsBuilder, WixDataIsReferencedOptionsBuilder, WixDataSearchOptionsBuilder, WixDataInsertOptionsBuilder, WixDataRemoveOptionsBuilder, WixDataBulkRemoveOptionsBuilder, WixDataAsyncRemoveByFilterOptionsBuilder, WixDataAsyncPatchByFilterOptionsBuilder, WixDataPatchOptionsBuilder, WixDataBulkPatchOptionsBuilder, WixDataSaveOptionsBuilder, WixDataBulkSaveOptionsBuilder, WixDataUpdateOptionsBuilder, WixDataBulkUpdateOptionsBuilder, WixDataBulkInsertOptionsBuilder, } from '@wix/wix-data-items-common';