@wix/data 1.0.8 → 1.0.10

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

@@ -78,7 +78,6 @@ 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/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -124,7 +123,6 @@ 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/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -164,7 +162,11 @@ export interface QueryV2PagingMethodOneOf {
 export interface Sorting {
     /** Name of the field to sort by. */
     fieldName?: string;
-    /** Sort order. */
+    /**
+     * Sort order.
+     *
+     * Supported values: `"ASC"`, `"DESC"`.
+     */
     order?: SortOrder;
 }
 export declare enum SortOrder {
@@ -241,7 +243,6 @@ 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/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -328,7 +329,6 @@ 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/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -358,7 +358,11 @@ export interface QueryDistinctValuesRequest extends QueryDistinctValuesRequestPa
      * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
      */
     filter?: Record<string, any> | null;
-    /** Sort order. */
+    /**
+     * Sort order.
+     *
+     * Supported values: `"ASC"`, `"DESC"`.
+     */
     order?: SortOrder;
     /**
      * Whether to return the total count in the response for a query with offset paging.
@@ -370,7 +374,6 @@ 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/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -409,7 +412,11 @@ export interface BulkInsertDataItemsResponse {
     bulkActionMetadata?: BulkActionMetadata;
 }
 export interface BulkDataItemResult {
-    /** The action attempted for the data item. */
+    /**
+     * The action attempted for the data item.
+     *
+     * Supported values: `"UNKNOWN_ACTION_TYPE"`, `"INSERT"`, `"UPDATE"`, `"DELETE"`.
+     */
     action?: BulkActionType;
     /** Metadata related to the data item for which the action was attempted. */
     itemMetadata?: ItemMetadata;
@@ -519,7 +526,6 @@ 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/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -569,7 +575,6 @@ 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/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -627,7 +632,11 @@ export interface BulkInsertDataItemReferencesResponse {
     bulkActionMetadata?: BulkActionMetadata;
 }
 export interface BulkDataItemReferenceResult {
-    /** The action attempted for the reference. */
+    /**
+     * The action attempted for the reference.
+     *
+     * Supported values: `"UNKNOWN_ACTION_TYPE"`, `"INSERT"`, `"UPDATE"`, `"DELETE"`.
+     */
     action?: BulkActionType;
     /** Metadata related to the reference for which the action was attempted. */
     referenceMetadata?: ItemMetadata;
@@ -665,7 +674,7 @@ 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/sdk/data/collections).
+ * You can create a new collection using the Data Collections API.
  *
  * 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.
@@ -678,6 +687,7 @@ export interface ReplaceDataItemReferencesResponse {
  * @requiredField options.dataCollectionId
  * @requiredField options.dataItem
  * @param options - Options for adding an item to a collection.
+ * @permissionScope Write Data
  */
 export declare function insertDataItem(options: InsertDataItemOptions): Promise<InsertDataItemResponse>;
 export interface InsertDataItemOptions {
@@ -709,6 +719,7 @@ export interface InsertDataItemOptions {
  * @requiredField options.dataCollectionId
  * @requiredField options.dataItem
  * @param options - Options for updating an item in a collection.
+ * @permissionScope Write Data
  */
 export declare function updateDataItem(_id: string, options: UpdateDataItemOptions): Promise<UpdateDataItemResponse>;
 export interface UpdateDataItemOptions {
@@ -751,6 +762,7 @@ export interface UpdateDataItemOptions {
  * @requiredField options.dataCollectionId
  * @requiredField options.dataItem
  * @param options - Options for saving an item in a collection.
+ * @permissionScope Write Data
  */
 export declare function saveDataItem(options: SaveDataItemOptions): Promise<SaveDataItemResponse>;
 export interface SaveDataItemOptions {
@@ -763,7 +775,7 @@ 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`.
+ * > **Note**: When calling `getDataItem()` following an update to your collection, the data retrieved may not contain the most recent changes. 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
@@ -771,6 +783,7 @@ export interface SaveDataItemOptions {
  * @requiredField options
  * @requiredField options.dataCollectionId
  * @param options - Options for retrieving an item from a collection.
+ * @permissionScope Read Data
  * @returns Retrieved item.
  */
 export declare function getDataItem(dataItemId: string, options: GetDataItemOptions): Promise<DataItem>;
@@ -780,7 +793,6 @@ 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/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -801,6 +813,7 @@ export interface GetDataItemOptions {
  * @requiredField options
  * @requiredField options.dataCollectionId
  * @param options - Options for removing an item from a collection.
+ * @permissionScope Write Data
  */
 export declare function removeDataItem(dataItemId: string, options: RemoveDataItemOptions): Promise<RemoveDataItemResponse>;
 export interface RemoveDataItemOptions {
@@ -820,6 +833,7 @@ export interface RemoveDataItemOptions {
  * @requiredField options
  * @requiredField options.dataCollectionId
  * @param options - Options for truncating data items from a collection.
+ * @permissionScope Write Data
  */
 export declare function truncateDataItems(options: TruncateDataItemsOptions): Promise<void>;
 export interface TruncateDataItemsOptions {
@@ -829,23 +843,23 @@ export interface TruncateDataItemsOptions {
 /**
  * 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 `queryDataItems()` function builds a query to retrieve data items from a collection and returns a `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.
+ * The returned object contains the query definition which is typically used to run the query using the `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.
+ * You can refine the query by chaining `DataItemsQueryBuilder` functions onto the query. `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:
+ * The `queryDataItems()` function runs with the following `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`
+ * + `skip`: 0
+ * + `limit`: 50
+ * + `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`.
+ * > **Note**: When calling `queryDataItems()` following an update to your collection, the data retrieved may not contain the most recent changes. If you need the most up-to-date data, set `options.consistentRead` to `true`.
  *
  *
  * @public
@@ -853,6 +867,7 @@ export interface TruncateDataItemsOptions {
  * @requiredField options.options
  * @requiredField options.options.dataCollectionId
  * @param options - Options for querying data items.
+ * @permissionScope Read Data
  */
 export declare function queryDataItems(options: QueryDataItemsOptions): DataItemsQueryBuilder;
 export interface QueryDataItemsOptions {
@@ -873,7 +888,6 @@ 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/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -949,6 +963,7 @@ export interface DataItemsQueryBuilder {
  * @requiredField options
  * @requiredField options.dataCollectionId
  * @param options - Options for running an aggregation.
+ * @permissionScope Read Data
  */
 export declare function aggregateDataItems(options: AggregateDataItemsOptions): Promise<AggregateDataItemsResponse>;
 export interface AggregateDataItemsOptions extends AggregateDataItemsRequestPagingMethodOneOf {
@@ -979,7 +994,6 @@ 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/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -988,12 +1002,13 @@ export interface AggregateDataItemsOptions extends AggregateDataItemsRequestPagi
 /**
  * Counts the number of items in a data collection that match the provided filtering preferences.
  *
- * > **Note**: When calling `countDataItems()` following an update to your collection, the result returned may not reflect 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`.
+ * > **Note**: When calling `countDataItems()` following an update to your collection, the result returned may not reflect the most recent changes. If you need the most up-to-date data, set `options.consistentRead` to `true`.
  * @public
  * @documentationMaturity preview
  * @requiredField options
  * @requiredField options.dataCollectionId
  * @param options - Options for counting the number of items in a data collection.
+ * @permissionScope Read Data
  */
 export declare function countDataItems(options: CountDataItemsOptions): Promise<CountDataItemsResponse>;
 export interface CountDataItemsOptions {
@@ -1013,7 +1028,6 @@ 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/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -1023,19 +1037,20 @@ export interface CountDataItemsOptions {
  * Retrieves a list of distinct values for a given field in all items that match a query, without duplicates.
  *
  *
- * 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.
+ * As with `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).
  *
- * > **Note**: When calling `queryDistinctValues()` following an update to your collection, the data retrieved may not reflect 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`.
+ * > **Note**: When calling `queryDistinctValues()` following an update to your collection, the data retrieved may not reflect the most recent changes. If you need the most up-to-date data, set `options.consistentRead` to `true`.
  * @public
  * @documentationMaturity preview
  * @requiredField options
  * @requiredField options.dataCollectionId
  * @param options - Options for querying distinct values.
+ * @permissionScope Read Data
  */
 export declare function queryDistinctValues(options: QueryDistinctValuesOptions): Promise<QueryDistinctValuesResponse>;
 export interface QueryDistinctValuesOptions extends QueryDistinctValuesRequestPagingMethodOneOf {
@@ -1054,7 +1069,11 @@ export interface QueryDistinctValuesOptions extends QueryDistinctValuesRequestPa
      * Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
      */
     filter?: Record<string, any> | null;
-    /** Sort order. */
+    /**
+     * Sort order.
+     *
+     * Supported values: `"ASC"`, `"DESC"`.
+     */
     order?: SortOrder;
     /** Paging options to limit and skip the number of items. */
     paging?: Paging;
@@ -1070,7 +1089,8 @@ 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/sdk/data/eventual-consistency).
+     *
+     * Default: `false`
      */
     consistentRead?: boolean;
 }
@@ -1086,6 +1106,7 @@ export interface QueryDistinctValuesOptions extends QueryDistinctValuesRequestPa
  * @requiredField options.dataCollectionId
  * @requiredField options.dataItems
  * @param options - Options for adding multiple items to a collection.
+ * @permissionScope Write Data
  */
 export declare function bulkInsertDataItems(options: BulkInsertDataItemsOptions): Promise<BulkInsertDataItemsResponse>;
 export interface BulkInsertDataItemsOptions {
@@ -1121,6 +1142,7 @@ export interface BulkInsertDataItemsOptions {
  * @requiredField options.dataCollectionId
  * @requiredField options.dataItems
  * @param options - Options for updating multiple items in a collection.
+ * @permissionScope Write Data
  */
 export declare function bulkUpdateDataItems(options: BulkUpdateDataItemsOptions): Promise<BulkUpdateDataItemsResponse>;
 export interface BulkUpdateDataItemsOptions {
@@ -1156,6 +1178,7 @@ export interface BulkUpdateDataItemsOptions {
  * @requiredField options.dataCollectionId
  * @requiredField options.dataItems
  * @param options - Options for saving multiple items in a collection.
+ * @permissionScope Write Data
  */
 export declare function bulkSaveDataItems(options: BulkSaveDataItemsOptions): Promise<BulkSaveDataItemsResponse>;
 export interface BulkSaveDataItemsOptions {
@@ -1184,6 +1207,7 @@ export interface BulkSaveDataItemsOptions {
  * @requiredField options.dataCollectionId
  * @requiredField options.dataItemIds
  * @param options - Options for removing multiple items from a collection.
+ * @permissionScope Write Data
  */
 export declare function bulkRemoveDataItems(options: BulkRemoveDataItemsOptions): Promise<BulkRemoveDataItemsResponse>;
 export interface BulkRemoveDataItemsOptions {
@@ -1203,12 +1227,13 @@ export interface BulkRemoveDataItemsOptions {
  * 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.
  *
- * > **Note**: When calling `queryReferencedDataItems()` 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`.
+ * > **Note**: When calling `queryReferencedDataItems()` following an update to your collection, the data retrieved may not contain the most recent changes. If you need the most up-to-date data, set `options.consistentRead` to `true`.
  * @public
  * @documentationMaturity preview
  * @requiredField options
  * @requiredField options.dataCollectionId
  * @param options - Options for querying referenced data items.
+ * @permissionScope Read Data
  */
 export declare function queryReferencedDataItems(options: QueryReferencedDataItemsOptions): Promise<QueryReferencedDataItemsResponse>;
 export interface QueryReferencedDataItemsOptions extends QueryReferencedDataItemsRequestPagingMethodOneOf {
@@ -1234,7 +1259,6 @@ 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/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -1243,7 +1267,7 @@ export interface QueryReferencedDataItemsOptions extends QueryReferencedDataItem
 /**
  * Checks whether a field in a referring item contains a reference to a specified item.
  *
- * > **Note**: When calling `isReferencedDataItem()` following an update to your collection, the result returned may not reflect 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`.
+ * > **Note**: When calling `isReferencedDataItem()` following an update to your collection, the result returned may not reflect the most recent changes. If you need the most up-to-date data, set `options.consistentRead` to `true`.
  * @public
  * @documentationMaturity preview
  * @requiredField options
@@ -1252,6 +1276,7 @@ export interface QueryReferencedDataItemsOptions extends QueryReferencedDataItem
  * @requiredField options.referringItemFieldName
  * @requiredField options.referringItemId
  * @param options - Options for checking whether a field contains a reference to an item.
+ * @permissionScope Read Data
  */
 export declare function isReferencedDataItem(options: IsReferencedDataItemOptions): Promise<IsReferencedDataItemResponse>;
 export interface IsReferencedDataItemOptions {
@@ -1266,7 +1291,6 @@ 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/sdk/data/eventual-consistency).
      *
      * Default: `false`
      */
@@ -1285,6 +1309,7 @@ export interface IsReferencedDataItemOptions {
  * @requiredField options.dataItemReference.referringItemFieldName
  * @requiredField options.dataItemReference.referringItemId
  * @param options - Options for inserting a reference.
+ * @permissionScope Write Data
  */
 export declare function insertDataItemReference(options: InsertDataItemReferenceOptions): Promise<InsertDataItemReferenceResponse>;
 export interface InsertDataItemReferenceOptions {
@@ -1304,6 +1329,7 @@ export interface InsertDataItemReferenceOptions {
  * @requiredField options.dataItemReference.referringItemFieldName
  * @requiredField options.dataItemReference.referringItemId
  * @param options - Options for removing a reference.
+ * @permissionScope Write Data
  */
 export declare function removeDataItemReference(options: RemoveDataItemReferenceOptions): Promise<RemoveDataItemReferenceResponse>;
 export interface RemoveDataItemReferenceOptions {
@@ -1327,6 +1353,7 @@ export interface RemoveDataItemReferenceOptions {
  * @requiredField options.dataItemReferences.referringItemFieldName
  * @requiredField options.dataItemReferences.referringItemId
  * @param options - Options for inserting one or more references.
+ * @permissionScope Write Data
  */
 export declare function bulkInsertDataItemReferences(options: BulkInsertDataItemReferencesOptions): Promise<BulkInsertDataItemReferencesResponse>;
 export interface BulkInsertDataItemReferencesOptions {
@@ -1353,6 +1380,7 @@ export interface BulkInsertDataItemReferencesOptions {
  * @requiredField options.dataItemReferences.referringItemFieldName
  * @requiredField options.dataItemReferences.referringItemId
  * @param options - Options for removing one or more references.
+ * @permissionScope Write Data
  */
 export declare function bulkRemoveDataItemReferences(options: BulkRemoveDataItemReferencesOptions): Promise<BulkRemoveDataItemReferencesResponse>;
 export interface BulkRemoveDataItemReferencesOptions {
@@ -1376,6 +1404,7 @@ export interface BulkRemoveDataItemReferencesOptions {
  * @requiredField options.referringItemFieldName
  * @requiredField options.referringItemId
  * @param options - Options for replacing references.
+ * @permissionScope Write Data
  */
 export declare function replaceDataItemReferences(options: ReplaceDataItemReferencesOptions): Promise<ReplaceDataItemReferencesResponse>;
 export interface ReplaceDataItemReferencesOptions {