@wix/data 1.0.3 → 1.0.4

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

@@ -78,7 +78,7 @@ export interface GetDataItemRequest {
     /**
      * Whether to retrieve data from the primary database instance.
      * This decreases performance but ensures data retrieved is up to date even immediately after an update.
-     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
+     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -124,7 +124,7 @@ export interface QueryDataItemsRequest {
     /**
      * Whether to retrieve data from the primary database instance.
      * This decreases performance but ensures data retrieved is up to date even immediately after an update.
-     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
+     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -241,7 +241,7 @@ export interface AggregateDataItemsRequest extends AggregateDataItemsRequestPagi
     /**
      * Whether to retrieve data from the primary database instance.
      * This decreases performance but ensures data retrieved is up to date even immediately after an update.
-     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
+     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -328,7 +328,7 @@ export interface CountDataItemsRequest {
     /**
      * Whether to retrieve data from the primary database instance.
      * This decreases performance but ensures data retrieved is up to date even immediately after an update.
-     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
+     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -370,7 +370,7 @@ export interface QueryDistinctValuesRequest extends QueryDistinctValuesRequestPa
     /**
      * Whether to retrieve data from the primary database instance.
      * This decreases performance but ensures data retrieved is up to date even immediately after an update.
-     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
+     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -519,7 +519,7 @@ export interface QueryReferencedDataItemsRequest extends QueryReferencedDataItem
     /**
      * Whether to retrieve data from the primary database instance.
      * This decreases performance but ensures data retrieved is up to date even immediately after an update.
-     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
+     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -569,7 +569,7 @@ export interface IsReferencedDataItemRequest {
     /**
      * Whether to retrieve data from the primary database instance.
      * This decreases performance but ensures data retrieved is up to date even immediately after an update.
-     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
+     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -665,18 +665,19 @@ export interface ReplaceDataItemReferencesResponse {
  *
  *
  * An item can only be inserted into an existing connection.
- * You can create a new collection using the [Data Collections API](https://dev.wix.com/api/rest/wix-data/wix-data/data-collections).
+ * You can create a new collection using the [Data Collections API](https://dev.wix.com/api/sdk/data/collections).
  *
  * When an item is inserted into a collection, the item's ID is automatically assigned a random value.
  * You can optionally provide a custom ID in `dataItem.id` when inserting the item.
  * If you specify an ID that already exists in the collection, the insertion will fail.
  *
- * If `dataItem.data` is empty, a new item is created with no data fields.
+ * If `options.dataItem.data` is empty, a new item is created with no data fields.
  * @public
  * @documentationMaturity preview
  * @requiredField options
  * @requiredField options.dataCollectionId
  * @requiredField options.dataItem
+ * @param options - Options for adding an item to a collection.
  */
 export declare function insertDataItem(options: InsertDataItemOptions): Promise<InsertDataItemResponse>;
 export interface InsertDataItemOptions {
@@ -689,7 +690,7 @@ export interface InsertDataItemOptions {
  * Updates an item in a collection.
  *
  *
- * This endpoint replaces the data item's existing data with the payload provided in `dataItem.data` in the request.
+ * This function replaces the data item's existing data with the payload provided in `options.dataItem.data` in the request.
  *
  * To update an item, you need to specify an item ID and a collection ID.
  * If an item is found in the specified collection with the specified ID, that item is updated.
@@ -698,7 +699,7 @@ export interface InsertDataItemOptions {
  * When an item is updated, its `data._updatedDate` field is changed to the current date and time.
  *
  * > **Note:**
- * > After an item is updated, it only contains the fields included in the `dataItem.data` payload in Update Data Item request.
+ * > After an item is updated, it only contains the fields included in the `options.dataItem.data` payload in the `updateDataItem()` call.
  * > If the existing item has fields with values and those fields aren't included in the updated item, their values are lost.
  * @param _id - Data item ID.
  * @public
@@ -707,9 +708,11 @@ export interface InsertDataItemOptions {
  * @requiredField options
  * @requiredField options.dataCollectionId
  * @requiredField options.dataItem
+ * @param options - Options for updating an item in a collection.
  */
 export declare function updateDataItem(_id: string, options: UpdateDataItemOptions): Promise<UpdateDataItemResponse>;
 export interface UpdateDataItemOptions {
+    /** Updated data item content. The existing data item's content is replaced entirely. */
     dataItem: {
         /** Data item ID. */
         _id?: string;
@@ -732,7 +735,7 @@ export interface UpdateDataItemOptions {
  * Inserts or updates an item in a collection.
  *
  *
- * The Save Data Item endpoint inserts or updates the specified item, depending on whether it already exists in the collection.
+ * The `saveDataItem()` function inserts or updates the specified item, depending on whether it already exists in the collection.
  *
  * + If you don't provide an ID, a new item is created.
  *
@@ -740,13 +743,14 @@ export interface UpdateDataItemOptions {
  *
  * + If an item with the ID you provide already exists in the collection, that item is updated. When an item is updated, its `data._updatedDate` field is changed to the current date and time.
  *
- * > **Note:** When you provide an item with an ID that already exists in the collection, the payload you provide in `dataItem.data` replaces the existing item with that ID.
+ * > **Note:** When you provide an item with an ID that already exists in the collection, the payload you provide in `options.dataItem.data` replaces the existing item with that ID.
  * > This means that the item's previous fields and values are lost.
  * @public
  * @documentationMaturity preview
  * @requiredField options
  * @requiredField options.dataCollectionId
  * @requiredField options.dataItem
+ * @param options - Options for saving an item in a collection.
  */
 export declare function saveDataItem(options: SaveDataItemOptions): Promise<SaveDataItemResponse>;
 export interface SaveDataItemOptions {
@@ -757,12 +761,16 @@ export interface SaveDataItemOptions {
 }
 /**
  * Retrieves an item from a collection.
+ *
+ *
+ * > **Note**: When calling `getDataItem()` following an update to your collection, the data retrieved may not contain the most recent changes. See [Wix Data and Eventual Consistency](https://dev.wix.com/api/sdk/data/eventual-consistency) for more details. If you need the most up-to-date data, set `options.consistentRead` to `true`.
  * @param dataItemId - ID of the data item to retrieve.
  * @public
  * @documentationMaturity preview
  * @requiredField dataItemId
  * @requiredField options
  * @requiredField options.dataCollectionId
+ * @param options - Options for retrieving an item from a collection.
  * @returns Retrieved item.
  */
 export declare function getDataItem(dataItemId: string, options: GetDataItemOptions): Promise<DataItem>;
@@ -772,7 +780,7 @@ export interface GetDataItemOptions {
     /**
      * Whether to retrieve data from the primary database instance.
      * This decreases performance but ensures data retrieved is up to date even immediately after an update.
-     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
+     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -792,6 +800,7 @@ export interface GetDataItemOptions {
  * @requiredField dataItemId
  * @requiredField options
  * @requiredField options.dataCollectionId
+ * @param options - Options for removing an item from a collection.
  */
 export declare function removeDataItem(dataItemId: string, options: RemoveDataItemOptions): Promise<RemoveDataItemResponse>;
 export interface RemoveDataItemOptions {
@@ -810,6 +819,7 @@ export interface RemoveDataItemOptions {
  * @documentationMaturity preview
  * @requiredField options
  * @requiredField options.dataCollectionId
+ * @param options - Options for truncating data items from a collection.
  */
 export declare function truncateDataItems(options: TruncateDataItemsOptions): Promise<void>;
 export interface TruncateDataItemsOptions {
@@ -817,14 +827,32 @@ export interface TruncateDataItemsOptions {
     dataCollectionId: string;
 }
 /**
- * Retrieves a list of items, on the basis of the filtering, sorting, and paging preferences you provide.
+ * Creates a query to retrieve items from a database collection.
+ *
+ * The `queryDataItems()` function builds a query to retrieve data items from a collection and returns a [`DataItemsQueryBuilder`](https://dev.wix.com/api/sdk/data/items/dataitemsquerybuilder) object.
+ *
+ * The returned object contains the query definition which is typically used to run the query using the [`find()`](https://dev.wix.com/api/sdk/data/items/dataitemsquerybuilder/find) function.
+ *
+ * You can refine the query by chaining [`DataItemsQueryBuilder](https://dev.wix.com/api/sdk/data/items/dataitemsquerybuilder) functions onto the query. [`DataItemsQueryBuilder](https://dev.wix.com/api/sdk/data/items/dataitemsquerybuilder) functions enable you to sort, filter, and control the results that `queryDataItems()` returns.
+ *
+ * The `queryDataItems()` function runs with the following [`DataItemsQueryBuilder](https://dev.wix.com/api/sdk/data/items/dataitemsquerybuilder) defaults that you can override:
+ *
+ * + [`skip`](https://dev.wix.com/api/sdk/data/items/dataitemsquerybuilder/skip): 0
+ * + [`limit`](https://dev.wix.com/api/sdk/data/items/dataitemsquerybuilder/limit): 50
+ * + [`descending`](https://dev.wix.com/api/sdk/data/items/dataitemsquerybuilder/descending): by `_createdDate`
+ *
+ * The functions that are chained to `queryDataItems()` are applied in the order they are called. For example, if you sort on an `age` field in ascending order and then on a `name` field in descending order, the results are sorted first by the age of the items and then, if there are multiple results with the same age, the items are sorted by name in descending order, per age value.
+ *
+ * If the collection that you are querying has references to other collections, by default the data from referenced collections is not retrieved. To get the data from referenced items, specify them in the `options.includeReferencedItems` parameter.
+ *
+ * > **Note**: When calling `queryDataItems()` following an update to your collection, the data retrieved may not contain the most recent changes. See [Wix Data and Eventual Consistency](https://dev.wix.com/api/sdk/data/items/getdataitem) for more details. If you need the most up-to-date data, set `options.consistentRead` to `true`.
  *
  *
- * For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
  * @public
  * @documentationMaturity preview
  * @requiredField options.options
  * @requiredField options.options.dataCollectionId
+ * @param options - Options for querying data items.
  */
 export declare function queryDataItems(options: QueryDataItemsOptions): DataItemsQueryBuilder;
 export interface QueryDataItemsOptions {
@@ -845,7 +873,7 @@ export interface QueryDataItemsOptions {
     /**
      * Whether to retrieve data from the primary database instance.
      * This decreases performance but ensures data retrieved is up to date even immediately after an update.
-     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
+     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -920,6 +948,7 @@ export interface DataItemsQueryBuilder {
  * @documentationMaturity preview
  * @requiredField options
  * @requiredField options.dataCollectionId
+ * @param options - Options for running an aggregation.
  */
 export declare function aggregateDataItems(options: AggregateDataItemsOptions): Promise<AggregateDataItemsResponse>;
 export interface AggregateDataItemsOptions extends AggregateDataItemsRequestPagingMethodOneOf {
@@ -950,7 +979,7 @@ export interface AggregateDataItemsOptions extends AggregateDataItemsRequestPagi
     /**
      * Whether to retrieve data from the primary database instance.
      * This decreases performance but ensures data retrieved is up to date even immediately after an update.
-     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
+     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -962,6 +991,7 @@ export interface AggregateDataItemsOptions extends AggregateDataItemsRequestPagi
  * @documentationMaturity preview
  * @requiredField options
  * @requiredField options.dataCollectionId
+ * @param options - Options for counting the number of items in a data collection.
  */
 export declare function countDataItems(options: CountDataItemsOptions): Promise<CountDataItemsResponse>;
 export interface CountDataItemsOptions {
@@ -981,7 +1011,7 @@ export interface CountDataItemsOptions {
     /**
      * Whether to retrieve data from the primary database instance.
      * This decreases performance but ensures data retrieved is up to date even immediately after an update.
-     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
+     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -991,9 +1021,9 @@ export interface CountDataItemsOptions {
  * Retrieves a list of distinct values for a given field in all items that match a query, without duplicates.
  *
  *
- * As with the [Query Data Items](https://dev.wix.com/api/rest/wix-data/wix-data/data-items/query-data-items) endpoint, this endpoint retrieves items based on the filtering, sorting, and paging preferences you provide.
- * However, the Query Distinct Values endpoint doesn't return all of the full items that match the query.
- * Rather, it returns all unique values of the field you specify in `fieldName` for items that match the query.
+ * As with [`queryDataItems()`](https://dev.wix.com/api/sdk/data/items/querydataitems), this endpoint retrieves items based on the filtering, sorting, and paging preferences you provide.
+ * However, `queryDistinctValues()` doesn't return all of the full items that match the query.
+ * Rather, it returns all unique values of the field you specify in `options.fieldName` for items that match the query.
  * If more than one item has the same value for that field, that value appears only once.
  *
  * For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
@@ -1001,6 +1031,7 @@ export interface CountDataItemsOptions {
  * @documentationMaturity preview
  * @requiredField options
  * @requiredField options.dataCollectionId
+ * @param options - Options for querying distinct values.
  */
 export declare function queryDistinctValues(options: QueryDistinctValuesOptions): Promise<QueryDistinctValuesResponse>;
 export interface QueryDistinctValuesOptions extends QueryDistinctValuesRequestPagingMethodOneOf {
@@ -1035,9 +1066,7 @@ export interface QueryDistinctValuesOptions extends QueryDistinctValuesRequestPa
     /**
      * Whether to retrieve data from the primary database instance.
      * This decreases performance but ensures data retrieved is up to date even immediately after an update.
-     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
-     *
-     * Default: `false`
+     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/sdk/data/eventual-consistency).
      */
     consistentRead?: boolean;
 }
@@ -1045,13 +1074,14 @@ export interface QueryDistinctValuesOptions extends QueryDistinctValuesRequestPa
  * Adds multiple items to a collection.
  *
  *
- * When each item is inserted into a collection, its ID is automatically assigned to random value.
+ * When each item is inserted into a collection, its ID is automatically assigned a random value.
  * You can optionally provide your own ID when inserting the item. If you specify an ID that already exists in the collection, the insertion will fail.
  * @public
  * @documentationMaturity preview
  * @requiredField options
  * @requiredField options.dataCollectionId
  * @requiredField options.dataItems
+ * @param options - Options for adding multiple items to a collection.
  */
 export declare function bulkInsertDataItems(options: BulkInsertDataItemsOptions): Promise<BulkInsertDataItemsResponse>;
 export interface BulkInsertDataItemsOptions {
@@ -1071,7 +1101,7 @@ export interface BulkInsertDataItemsOptions {
  * Updates multiple items in a collection.
  *
  *
- * This endpoint replaces each specified data item's existing data with the payload provided in the request.
+ * This function replaces each specified data item's existing data with the payload provided in the request.
  *
  * Each item in the request must include an ID. If an item is found in the specified collection with
  * the same ID, that item is updated. If the collection doesn't contain an item with that ID, the update fails.
@@ -1086,6 +1116,7 @@ export interface BulkInsertDataItemsOptions {
  * @requiredField options
  * @requiredField options.dataCollectionId
  * @requiredField options.dataItems
+ * @param options - Options for updating multiple items in a collection.
  */
 export declare function bulkUpdateDataItems(options: BulkUpdateDataItemsOptions): Promise<BulkUpdateDataItemsResponse>;
 export interface BulkUpdateDataItemsOptions {
@@ -1105,7 +1136,7 @@ export interface BulkUpdateDataItemsOptions {
  * Inserts or updates multiple items in a collection.
  *
  *
- * The Bulk Save Data Items endpoint inserts or updates each item provided, depending on whether it already exists in the collection. For each item:
+ * This function inserts or updates each item provided, depending on whether it already exists in the collection. For each item:
  *
  * + If you don't provide an ID, a new item is created.
  *
@@ -1120,6 +1151,7 @@ export interface BulkUpdateDataItemsOptions {
  * @requiredField options
  * @requiredField options.dataCollectionId
  * @requiredField options.dataItems
+ * @param options - Options for saving multiple items in a collection.
  */
 export declare function bulkSaveDataItems(options: BulkSaveDataItemsOptions): Promise<BulkSaveDataItemsResponse>;
 export interface BulkSaveDataItemsOptions {
@@ -1147,6 +1179,7 @@ export interface BulkSaveDataItemsOptions {
  * @requiredField options
  * @requiredField options.dataCollectionId
  * @requiredField options.dataItemIds
+ * @param options - Options for removing multiple items from a collection.
  */
 export declare function bulkRemoveDataItems(options: BulkRemoveDataItemsOptions): Promise<BulkRemoveDataItemsResponse>;
 export interface BulkRemoveDataItemsOptions {
@@ -1160,15 +1193,16 @@ export interface BulkRemoveDataItemsOptions {
  *
  *
  * Reference and multi-reference fields refer to items in different collections.
- * Use this endpoint to retrieve the full details of the referenced items themselves.
+ * Use this function to retrieve the full details of the referenced items themselves.
  *
  * 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 the Query Referenced Data Items endpoint returns the relevant **People** items referenced in the **Actors** field of the specified **Movie** item.
+ * Querying the **Movies** collection using `queryReferencedDataItems()` returns 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.
  * @public
  * @documentationMaturity preview
  * @requiredField options
  * @requiredField options.dataCollectionId
+ * @param options - Options for querying referenced data items.
  */
 export declare function queryReferencedDataItems(options: QueryReferencedDataItemsOptions): Promise<QueryReferencedDataItemsResponse>;
 export interface QueryReferencedDataItemsOptions extends QueryReferencedDataItemsRequestPagingMethodOneOf {
@@ -1194,7 +1228,7 @@ export interface QueryReferencedDataItemsOptions extends QueryReferencedDataItem
     /**
      * Whether to retrieve data from the primary database instance.
      * This decreases performance but ensures data retrieved is up to date even immediately after an update.
-     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
+     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -1209,6 +1243,7 @@ export interface QueryReferencedDataItemsOptions extends QueryReferencedDataItem
  * @requiredField options.referencedItemId
  * @requiredField options.referringItemFieldName
  * @requiredField options.referringItemId
+ * @param options - Options for checking whether a field contains a reference to an item.
  */
 export declare function isReferencedDataItem(options: IsReferencedDataItemOptions): Promise<IsReferencedDataItemResponse>;
 export interface IsReferencedDataItemOptions {
@@ -1223,7 +1258,7 @@ export interface IsReferencedDataItemOptions {
     /**
      * Whether to retrieve data from the primary database instance.
      * This decreases performance but ensures data retrieved is up to date even immediately after an update.
-     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
+     * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -1233,7 +1268,7 @@ export interface IsReferencedDataItemOptions {
  * Inserts a reference in the specified field in an item in a collection.
  *
  *
- * A reference in the `dataItemReference` field specifies a referring item's ID, the field in which to insert the reference, and the ID of the referenced item.
+ * A reference in `options.dataItemReference` specifies a referring item's ID, the field in which to insert the reference, and the ID of the referenced item.
  * @public
  * @documentationMaturity preview
  * @requiredField options
@@ -1241,6 +1276,7 @@ export interface IsReferencedDataItemOptions {
  * @requiredField options.dataItemReference.referencedItemId
  * @requiredField options.dataItemReference.referringItemFieldName
  * @requiredField options.dataItemReference.referringItemId
+ * @param options - Options for inserting a reference.
  */
 export declare function insertDataItemReference(options: InsertDataItemReferenceOptions): Promise<InsertDataItemReferenceResponse>;
 export interface InsertDataItemReferenceOptions {
@@ -1259,6 +1295,7 @@ export interface InsertDataItemReferenceOptions {
  * @requiredField options.dataItemReference.referencedItemId
  * @requiredField options.dataItemReference.referringItemFieldName
  * @requiredField options.dataItemReference.referringItemId
+ * @param options - Options for removing a reference.
  */
 export declare function removeDataItemReference(options: RemoveDataItemReferenceOptions): Promise<RemoveDataItemReferenceResponse>;
 export interface RemoveDataItemReferenceOptions {
@@ -1272,7 +1309,7 @@ export interface RemoveDataItemReferenceOptions {
  *
  *
  * This endpoint adds one or more references to a collection.
- * Each new reference in the `dataItemReferences` field specifies a referring item's ID, the field in which to insert the reference, and the ID of the referenced item.
+ * Each new reference in `options.dataItemReferences` specifies a referring item's ID, the field in which to insert the reference, and the ID of the referenced item.
  * @public
  * @documentationMaturity preview
  * @requiredField options
@@ -1281,6 +1318,7 @@ export interface RemoveDataItemReferenceOptions {
  * @requiredField options.dataItemReferences.referencedItemId
  * @requiredField options.dataItemReferences.referringItemFieldName
  * @requiredField options.dataItemReferences.referringItemId
+ * @param options - Options for inserting one or more references.
  */
 export declare function bulkInsertDataItemReferences(options: BulkInsertDataItemReferencesOptions): Promise<BulkInsertDataItemReferencesResponse>;
 export interface BulkInsertDataItemReferencesOptions {
@@ -1306,6 +1344,7 @@ export interface BulkInsertDataItemReferencesOptions {
  * @requiredField options.dataItemReferences.referencedItemId
  * @requiredField options.dataItemReferences.referringItemFieldName
  * @requiredField options.dataItemReferences.referringItemId
+ * @param options - Options for removing one or more references.
  */
 export declare function bulkRemoveDataItemReferences(options: BulkRemoveDataItemReferencesOptions): Promise<BulkRemoveDataItemReferencesResponse>;
 export interface BulkRemoveDataItemReferencesOptions {
@@ -1318,16 +1357,17 @@ export interface BulkRemoveDataItemReferencesOptions {
  * Replaces references in a specified field of a specified data item.
  *
  *
- * This endpoint replaces the existing reference or references contained in the field specified in `referringItemFieldName` within the data item specified in `referringItemId`.
- * The endpoint removes existing references and in their place it adds references to the items specified in `newReferencedItemIds`.
+ * This function replaces the existing reference or references contained in the field specified in `options.referringItemFieldName` within the data item specified in `options.referringItemId`.
+ * The function removes existing references and in their place it adds references to the items specified in `options.newReferencedItemIds`.
  *
- * > **Note:** If you pass an empty array in `newReferencedItemIds`, all existing references are removed.
+ * > **Note:** If you pass an empty array in `options.newReferencedItemIds`, all existing references are removed.
  * @public
  * @documentationMaturity preview
  * @requiredField options
  * @requiredField options.dataCollectionId
  * @requiredField options.referringItemFieldName
  * @requiredField options.referringItemId
+ * @param options - Options for replacing references.
  */
 export declare function replaceDataItemReferences(options: ReplaceDataItemReferencesOptions): Promise<ReplaceDataItemReferencesResponse>;
 export interface ReplaceDataItemReferencesOptions {