@wix/wix-data-items-common 1.0.199 → 1.0.200

package/dist/types/types/data-item-types.d.ts

@@ -1590,475 +1590,633 @@ export interface SearchDataItemsResponse {
     pagingMetadata?: PagingMetadataV2;
 }
 export interface AggregatePipelineDataItemsRequest extends AggregatePipelineDataItemsRequestPagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
+    /**
+     * Paging options to limit and skip the number of results.
+     *
+     * Learn more about [sorting and paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging).
+     */
     paging?: Paging;
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    /**
+     * Cursor token referring to a page of results.
+     *
+     * The token isn't used in the first request. Subsequent requests use the cursor token and not `filter` or `sort`.
+     */
     cursorPaging?: CursorPaging;
     /**
-     * Environment: LIVE or SANDBOX
+     * Environment: `LIVE` or `SANDBOX`.
      * @internal
      */
     environment?: Environment;
     /**
-     * ID of the collection on which to run the aggregation.
+     * ID of the collection to run the aggregation pipeline on.
      * @maxLength 256
      */
     dataCollectionId: string;
     /**
-     * Aggregation operations applied (in order) to the data.
+     * Sequence of aggregation operations to apply to the data.
+     *
+     * Stages are processed in order, with each stage operating on the output of the previous stage.
      * @maxSize 100
      */
     stages?: Stage[];
     /**
-     * Whether to return the total count in the response for a query with offset paging.
-     * When `true`, the `pagingMetadata` object in the response contains a `total` field.
+     * Whether to return the total result count when running a query with offset paging.
+     *
+     * When `true`, the `pagingMetadata` property in the response contains a `total` field.
+     *
+     * Learn more about [offset paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging#paging).
      *
      * Default: `false`
      */
     returnTotalCount?: boolean;
     /**
-     * Grid app id. Optional in Live segment.
+     * Grid app ID. Optional in Live segment.
      * @internal
      * @format GUID
      */
     appId?: string | null;
     /**
-     * Whether to retrieve data from the primary database instance.
+     * Whether to read from the primary database for the most current data.
+     *
      * 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`
      */
     consistentRead?: boolean;
     /**
-     * Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
-     * If provided, the result text is returned in the specified language.
-     * **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
+     * Language to run the aggregation on, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
      *
-     * If not provided, result text is not translated.
+     * When provided, the aggregation runs on items in the specified language. When not provided, the aggregation runs on items in the default language.
+     *
+     * > **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
+     *
+     * Learn more about [Using Wix Multilingual to Translate CMS Content](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content).
      * @format LANGUAGE_TAG
      */
     language?: string | null;
     /**
      * Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
      *
-     * When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters:
-     * - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
-     * - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+     * Learn more about [querying Wix app collections](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-app-collections/querying-wix-app-collections).
      */
     appOptions?: Record<string, any> | null;
     /**
      * Options for the Publish plugin.
-     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+     *
+     * This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items aren't.
      */
     publishPluginOptions?: DataPublishPluginOptions;
 }
 /** @oneof */
 export interface AggregatePipelineDataItemsRequestPagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
+    /**
+     * Paging options to limit and skip the number of results.
+     *
+     * Learn more about [sorting and paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging).
+     */
     paging?: Paging;
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    /**
+     * Cursor token referring to a page of results.
+     *
+     * The token isn't used in the first request. Subsequent requests use the cursor token and not `filter` or `sort`.
+     */
     cursorPaging?: CursorPaging;
 }
 export interface Expression extends ExpressionValueOneOf {
     /**
-     * Field path to the value of field in the document.
+     * Path to the field that contains the value to use in the expression.
+     *
+     * Use dot notation to specify nested fields, such as `user.name` or `product.price`.
      * @maxLength 1000
      */
     fieldPath?: string;
     /**
-     * String constant value.
+     * Text value.
      * @maxLength 1000
      */
-    stringValue?: string;
-    /** Numeric constant value. */
-    numericValue?: number;
-    /** Add expression */
+    text?: string;
+    /** Numeric value. */
+    numeric?: number;
+    /** Adds the specified expressions together. */
     add?: AddOperation;
-    /** Sum expression */
+    /** Calculates the total sum of multiple expressions. */
     sum?: SumOperation;
-    /** Subtract expression */
+    /** Subtracts 1 expression from another. */
     subtract?: SubtractOperation;
-    /** Multiply expression */
+    /** Multiplies multiple expressions together. */
     multiply?: MultiplyOperation;
-    /** Divide expression */
+    /** Divides 1 expression by another. */
     divide?: DivideOperation;
-    /** Abs expression */
+    /** Finds the absolute value of an expression. */
     abs?: AbsOperation;
-    /** Mod expression */
+    /** Finds the remainder when dividing 1 expression by another. */
     mod?: ModOperation;
-    /** Floor expression */
+    /** Rounds an expression down to the nearest whole number. */
     floor?: FloorOperation;
-    /** Ceil expression */
+    /** Rounds an expression up to the nearest whole number. */
     ceil?: CeilOperation;
-    /** Concat expression */
+    /** Joins multiple expressions together to create a new string. */
     concat?: ConcatOperation;
-    /** Stringify expression */
+    /** Converts an expression into a string. */
     stringify?: StringifyOperation;
-    /** ToLower expression */
+    /** Converts an expression into lowercase. */
     toLower?: ToLowerOperation;
-    /** ToUpper expression */
+    /** Converts an expression into uppercase. */
     toUpper?: ToUpperOperation;
-    /** Substring expression */
+    /** Extracts a portion of a string expression. */
     substring?: SubstringOperation;
-    /** Length expression */
+    /** Finds the length of a string expression. */
     length?: LengthOperation;
 }
 /** @oneof */
 export interface ExpressionValueOneOf {
     /**
-     * Field path to the value of field in the document.
+     * Path to the field that contains the value to use in the expression.
+     *
+     * Use dot notation to specify nested fields, such as `user.name` or `product.price`.
      * @maxLength 1000
      */
     fieldPath?: string;
     /**
-     * String constant value.
+     * Text value.
      * @maxLength 1000
      */
-    stringValue?: string;
-    /** Numeric constant value. */
-    numericValue?: number;
-    /** Add expression */
+    text?: string;
+    /** Numeric value. */
+    numeric?: number;
+    /** Adds the specified expressions together. */
     add?: AddOperation;
-    /** Sum expression */
+    /** Calculates the total sum of multiple expressions. */
     sum?: SumOperation;
-    /** Subtract expression */
+    /** Subtracts 1 expression from another. */
     subtract?: SubtractOperation;
-    /** Multiply expression */
+    /** Multiplies multiple expressions together. */
     multiply?: MultiplyOperation;
-    /** Divide expression */
+    /** Divides 1 expression by another. */
     divide?: DivideOperation;
-    /** Abs expression */
+    /** Finds the absolute value of an expression. */
     abs?: AbsOperation;
-    /** Mod expression */
+    /** Finds the remainder when dividing 1 expression by another. */
     mod?: ModOperation;
-    /** Floor expression */
+    /** Rounds an expression down to the nearest whole number. */
     floor?: FloorOperation;
-    /** Ceil expression */
+    /** Rounds an expression up to the nearest whole number. */
     ceil?: CeilOperation;
-    /** Concat expression */
+    /** Joins multiple expressions together to create a new string. */
     concat?: ConcatOperation;
-    /** Stringify expression */
+    /** Converts an expression into a string. */
     stringify?: StringifyOperation;
-    /** ToLower expression */
+    /** Converts an expression into lowercase. */
     toLower?: ToLowerOperation;
-    /** ToUpper expression */
+    /** Converts an expression into uppercase. */
     toUpper?: ToUpperOperation;
-    /** Substring expression */
+    /** Extracts a portion of a string expression. */
     substring?: SubstringOperation;
-    /** Length expression */
+    /** Finds the length of a string expression. */
     length?: LengthOperation;
 }
 export interface AddOperation {
     /**
-     * Add expressions.
+     * Expressions to add together.
+     *
+     * All expressions must resolve to numbers.
      * @maxSize 1000
      */
     expressions?: Expression[];
 }
 export interface SumOperation {
     /**
-     * Sum expressions.
+     * Expressions to calculate the total sum of.
+     *
+     * All expressions must resolve to numbers.
      * @maxSize 1000
      */
     expressions?: Expression[];
 }
 export interface SubtractOperation {
-    /** Expression to subtract from */
+    /**
+     * Expression to subtract `secondExpression` from.
+     *
+     * Expression must resolve to a number.
+     */
     firstExpression?: Expression;
-    /** Expression to subtract by */
+    /**
+     * Expression to subtract from `firstExpression`.
+     *
+     * Expression must resolve to a number.
+     */
     secondExpression?: Expression;
 }
 export interface MultiplyOperation {
     /**
-     * Multiply expressions.
+     * Expressions to multiply.
+     *
+     * Expressions must resolve to numbers.
      * @maxSize 1000
      */
     expressions?: Expression[];
 }
 export interface DivideOperation {
-    /** Expression to divide from */
+    /**
+     * Expression to divide by `secondExpression`.
+     *
+     * Expression must resolve to a number.
+     */
     firstExpression?: Expression;
-    /** Expression to divide by */
+    /**
+     * Expression to divide `firstExpression` by.
+     *
+     * Expression must resolve to a non-zero number.
+     */
     secondExpression?: Expression;
 }
 export interface AbsOperation {
-    /** Expression to calculate absolute value of. */
+    /**
+     * Expression to find the absolute value of.
+     *
+     * Expression must resolve to a number.
+     */
     expression?: Expression;
 }
 export interface ModOperation {
-    /** Expression to calculate modulo from */
+    /**
+     * Expression to divide by `secondExpression`.
+     *
+     * Expression must resolve to a number.
+     */
     firstExpression?: Expression;
-    /** Expression to calculate modulo by */
+    /**
+     * Expression to divide `firstExpression` by.
+     *
+     * Expression must resolve to a non-zero number.
+     */
     secondExpression?: Expression;
 }
 export interface FloorOperation {
-    /** Expression to calculate floor value of. */
+    /**
+     * Expression to round down to the nearest whole number.
+     *
+     * Expression must resolve to a number.
+     */
     expression?: Expression;
 }
 export interface CeilOperation {
-    /** Expression to calculate ceil value of. */
+    /**
+     * Expression to round up to the nearest whole number.
+     *
+     * Expression must resolve to a number.
+     */
     expression?: Expression;
 }
 export interface ConcatOperation {
     /**
-     * Expression to concatenate.
+     * Expressions to join together.
+     *
+     * Expressions must resolve to strings.
      * @maxSize 1000
      */
     expressions?: Expression[];
 }
 export interface StringifyOperation {
-    /** Expression to convert to string. */
+    /** Expression to convert into a string. */
     expression?: Expression;
 }
 export interface ToLowerOperation {
-    /** Expression to convert to lower case. */
+    /**
+     * Expression to convert to lowercase.
+     *
+     * Expression must resolve to a string.
+     */
     expression?: Expression;
 }
 export interface ToUpperOperation {
-    /** Expression to convert to upper case. */
+    /**
+     * Expression to convert to uppercase.
+     *
+     * Expression must resolve to a string.
+     */
     expression?: Expression;
 }
 export interface SubstringOperation {
-    /** Expression to extract substring from. */
+    /**
+     * Expression to extract a substring from.
+     *
+     * Expression must resolve to a string.
+     */
     expression?: Expression;
-    /** Number expression of start index of substring. */
+    /**
+     * Starting position of the substring to extract. Use zero-based indexing.
+     *
+     * Expression must resolve to a number.
+     */
     startExpression?: Expression;
-    /** Number expression of length of substring. */
+    /**
+     * Number of characters to extract from the starting position.
+     *
+     * Expression must resolve to a number.
+     */
     lengthExpression?: Expression;
 }
 export interface LengthOperation {
-    /** Expression to calculate length of. */
+    /**
+     * Expression to calculate the character count of.
+     *
+     * Expression must resolve to a string.
+     */
     expression?: Expression;
 }
 export interface Avg {
-    /** Expression to be evaluated and used for calculating the average value in the grouping. */
+    /**
+     * Expression by which to calculate the group's average value.
+     *
+     * Expression must resolve to a number.
+     */
     expression?: Expression;
 }
 export interface AccumulatorMin {
-    /** Expression to be evaluated and used as the minimum value in the grouping. */
+    /**
+     * Expression by which to find the group's minimum value.
+     *
+     * Expression must resolve to a comparable value, such as a number or string.
+     */
     expression?: Expression;
 }
 export interface AccumulatorMax {
-    /** Expression to be evaluated and used as the maximum value in the grouping. */
+    /**
+     * Expression by which to find the group's maximum value.
+     *
+     * Expression must resolve to a comparable value, such as a number or string.
+     */
     expression?: Expression;
 }
 export interface AccumulatorSum {
-    /** Expression to be evaluated and used as the sum value in the grouping. */
+    /**
+     * Expression by which to calculate the group's total sum.
+     *
+     * Expression must resolve to a number.
+     */
     expression?: Expression;
 }
 export interface First {
-    /** Expression to be evaluated and used as the first value in the grouping. */
+    /** Expression by which to find the first item in the group. */
     expression?: Expression;
 }
 export interface Last {
-    /** Expression to be evaluated and used as the last value in the grouping. */
+    /** Expression by which to find the last item in the group. */
     expression?: Expression;
 }
 export interface Push {
-    /** Expression to be evaluated and pushed to the resulting document. */
+    /** Expression by which to collect items into an array. */
     expression?: Expression;
 }
 export interface Include {
     /**
-     * Field name of the field to be included in the resulting document.
+     * Key of the field to include in the result.
+     *
+     * Use dot notation to specify nested fields, such as `user.name` or `product.price`. Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
      * @maxLength 1000
      */
     fieldName?: string;
 }
 export interface Exclude {
     /**
-     * Field name of the field to be excluded from the resulting document.
+     * Key of the field to exclude from the result.
+     *
+     * Use dot notation to specify nested fields, such as `user.name` or `product.price`. Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
      * @maxLength 1000
      */
     fieldName?: string;
 }
-export interface ProjectionExpression {
+export interface Reshape {
     /**
-     * Field name of resulting expression
+     * Key of the field to create in the result item.
+     *
+     * Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
      * @maxLength 1000
      */
-    fieldName?: string;
-    /** Expression to be evaluated. */
+    resultFieldName?: string;
+    /** Expression to resolve. The result of the expression is the value of the new field. */
     expression?: Expression;
 }
-export interface ProjectionFields {
+export interface ProjectNested {
     /**
-     * Field name of resulting document
+     * Key of the parent field for the nested fields.
+     *
+     * Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
      * @maxLength 1000
      */
-    fieldName?: string;
+    resultFieldName?: string;
     /**
-     * Fields to be included in the resulting document.
+     * Nested fields to include, exclude, or calculate by running aggregations.
      * @maxSize 1000
      */
     fields?: Field[];
 }
 export interface Field extends FieldProjectionOneOf {
-    /** When used include only specified field in resulting document. */
+    /** When specified, includes only the specified field in the result. All other fields are excluded. */
     include?: Include;
-    /** When used all fields are included in resulting document except specified fields. */
+    /** When specified, excludes the specified field from the result. All other fields are included. */
     exclude?: Exclude;
-    /** When used new fields created based on underlying arithmetic operations. */
-    projectionExpression?: ProjectionExpression;
-    /** Nested fields to be projected in the resulting document. */
-    projectionFields?: ProjectionFields;
+    /** Reshape a new field based on the specified expression. */
+    reshape?: Reshape;
+    /** Project nested fields by including, excluding, or reshaping new fields. */
+    projectNested?: ProjectNested;
 }
 /** @oneof */
 export interface FieldProjectionOneOf {
-    /** When used include only specified field in resulting document. */
+    /** When specified, includes only the specified field in the result. All other fields are excluded. */
     include?: Include;
-    /** When used all fields are included in resulting document except specified fields. */
+    /** When specified, excludes the specified field from the result. All other fields are included. */
     exclude?: Exclude;
-    /** When used new fields created based on underlying arithmetic operations. */
-    projectionExpression?: ProjectionExpression;
-    /** Nested fields to be projected in the resulting document. */
-    projectionFields?: ProjectionFields;
+    /** Reshape a new field based on the specified expression. */
+    reshape?: Reshape;
+    /** Project nested fields by including, excluding, or reshaping new fields. */
+    projectNested?: ProjectNested;
 }
-export interface Id {
+export interface GroupId {
     /**
-     * Group identifier key.
+     * Name of the field to group items by.
+     *
+     * This becomes the field name in the result's `_id` property.
      * @maxLength 1000
      */
     key?: string;
-    /** Group expression value. */
+    /** Expression by which to determine the grouping value. Items whose expression resolves to the same value are grouped together in the result item's `_id` property. */
     expression?: Expression;
 }
 export interface Accumulator extends AccumulatorExpressionOneOf {
-    /** Calculate the average value of a specified field for all items in the grouping. */
+    /** Calculates the average value across all items in the group, based on the specified expression. */
     avg?: Avg;
-    /** Calculate the minimum value of a specified field for all items in the grouping. */
+    /** Finds the minimum value across all items in the group. */
     min?: AccumulatorMin;
-    /** Calculate the maximum value of a specified field for all items in the grouping. */
+    /** Finds the maximum value across all items in the group. */
     max?: AccumulatorMax;
-    /** Calculate the sum of values of a specified field for all items in the grouping. */
+    /** Calculates the sum of the specified expression across all items in the group. */
     sum?: AccumulatorSum;
-    /** Use first result from calculated grouping. */
+    /** Finds the first item in the group. */
     first?: First;
-    /** Use last result from calculated grouping. */
+    /** Finds the last item in the group. */
     last?: Last;
-    /** Execute calculation by group & push result to resulting group document. */
+    /** Collects values from all items in the group into an array. */
     push?: Push;
     /**
-     * Accumulator result field name.
+     * Key of the field to create in the output item to contain the aggregation result.
      * @maxLength 1000
      */
     resultFieldName?: string;
 }
 /** @oneof */
 export interface AccumulatorExpressionOneOf {
-    /** Calculate the average value of a specified field for all items in the grouping. */
+    /** Calculates the average value across all items in the group, based on the specified expression. */
     avg?: Avg;
-    /** Calculate the minimum value of a specified field for all items in the grouping. */
+    /** Finds the minimum value across all items in the group. */
     min?: AccumulatorMin;
-    /** Calculate the maximum value of a specified field for all items in the grouping. */
+    /** Finds the maximum value across all items in the group. */
     max?: AccumulatorMax;
-    /** Calculate the sum of values of a specified field for all items in the grouping. */
+    /** Calculates the sum of the specified expression across all items in the group. */
     sum?: AccumulatorSum;
-    /** Use first result from calculated grouping. */
+    /** Finds the first item in the group. */
     first?: First;
-    /** Use last result from calculated grouping. */
+    /** Finds the last item in the group. */
     last?: Last;
-    /** Execute calculation by group & push result to resulting group document. */
+    /** Collects values from all items in the group into an array. */
     push?: Push;
 }
 export interface Group {
     /**
-     * Fields by which to group items for the aggregation. If empty, the aggregation is carried out on all items in the collection.
+     * Grouping criteria by which to organize items.
+     *
+     * Each `Id` specifies a field by which to group items, and serves as the result item's unique `_id` property.
+     *
+     * Collection items with identical values for the specified `expression` are placed in the same group based on the specified `key`. If empty, all items are treated as a single group.
      * @maxSize 1000
      */
-    ids?: Id[];
+    groupIds?: GroupId[];
     /**
-     * Operations to carry out on the data in each grouping.
+     * Accumulation operations to run on each group.
+     *
+     * Accumulators aggregate data across all items in the group and return the result in a new field.
+     *
+     * > **Note:** When using accumulators, the type of expression must match the operation type. For example, when using the `sum` accumulator, the specified expression must resolve to a number.
      * @maxSize 1000
      */
     accumulators?: Accumulator[];
 }
 export interface AggregatePipelineDataItemsRequestSorting {
     /**
-     * Sort by one or more fields.
+     * Fields to sort the results by.
      * @maxSize 1000
      */
     values?: Sorting[];
 }
-/** Project document to include specific fields, rename or perform arithmetic operations on them. */
+/** Transform individual collection items by including, excluding, or calculating new fields based on aggregations. */
 export interface Projection {
     /**
-     * Field transformation projections.
+     * Nested fields to include, exclude, or calculate by running aggregations.
      * @maxSize 1000
      */
     fields?: Field[];
 }
-/** Transform object to array. */
+/** Convert an object into an array. */
 export interface ObjectToArray {
     /**
-     * Field name of source document array field
+     * Key of the field to convert into an array.
+     *
+     * Use dot notation to specify nested fields, such as `user.name` or `product.price`. Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
      * @maxLength 1000
      */
-    arrayFieldName?: string;
+    objectFieldName?: string;
     /**
-     * Target field name for the projected document.
+     * Key of the new array to create in the result item.
+     *
+     * Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
      * @maxLength 1000
      */
     destinationFieldName?: string;
 }
-/** Unwind array field. */
+/** Unwind an array. */
 export interface UnwindArray {
     /**
-     * Field name of source document array field
+     * Key of the array field to unwind.
+     *
+     * Use dot notation to specify a nested array, such as `user.products` or `product.price`. Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
      * @maxLength 1000
      */
     arrayFieldName?: string;
 }
 export interface Stage extends StageStageOneOf {
-    /** Grouping stage. */
+    /**
+     * Group.
+     *
+     * Groups aggregate data across multiple collection items and create new result items.
+     */
     group?: Group;
     /**
-     * Filtering stage. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section) for information on how to structure a filter object.
+     * Aggregation filter. Only collection items that match the filter are processed.
      *
-     * **Note:** The values you provide for each filter field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
+     * Learn more about [filters in API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language#filters).
+     *
+     * > **Note:** The values you provide for each filter field must adhere to that field's data type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * Sorting preferences.
+     *
+     * Learn more about [sorting and paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging).
      */
     sort?: AggregatePipelineDataItemsRequestSorting;
-    /** Project document to include specific fields with possibility of renaming them. */
+    /** Transform collection items by including, excluding, or calculating new fields. */
     projection?: Projection;
-    /** Transform object to array. */
+    /** Convert an object into an array. Each property becomes an element in the new array. Each new array element also includes all other fields from the original object. */
     objectToArray?: ObjectToArray;
-    /** Unwind array field. */
+    /**
+     * Deconstructs an array field into separate result items.
+     *
+     * Creates a new result object for each element in the specified array. Each new object contains the array element's value, as well as all other fields from the original element.
+     */
     unwindArray?: UnwindArray;
-    /** Skip resulting documents. */
+    /** Number of results to skip from the beginning of the result set. */
     skip?: number;
-    /** Limit the number of resulting documents. */
+    /** Maximum number of results to return. */
     limit?: number;
 }
 /** @oneof */
 export interface StageStageOneOf {
-    /** Grouping stage. */
+    /**
+     * Group.
+     *
+     * Groups aggregate data across multiple collection items and create new result items.
+     */
     group?: Group;
     /**
-     * Filtering stage. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_the-filter-section) for information on how to structure a filter object.
+     * Aggregation filter. Only collection items that match the filter are processed.
      *
-     * **Note:** The values you provide for each filter field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
+     * Learn more about [filters in API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language#filters).
+     *
+     * > **Note:** The values you provide for each filter field must adhere to that field's data type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * Sorting preferences.
+     *
+     * Learn more about [sorting and paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging).
      */
     sort?: AggregatePipelineDataItemsRequestSorting;
-    /** Project document to include specific fields with possibility of renaming them. */
+    /** Transform collection items by including, excluding, or calculating new fields. */
     projection?: Projection;
-    /** Transform object to array. */
+    /** Convert an object into an array. Each property becomes an element in the new array. Each new array element also includes all other fields from the original object. */
     objectToArray?: ObjectToArray;
-    /** Unwind array field. */
+    /**
+     * Deconstructs an array field into separate result items.
+     *
+     * Creates a new result object for each element in the specified array. Each new object contains the array element's value, as well as all other fields from the original element.
+     */
     unwindArray?: UnwindArray;
-    /** Skip resulting documents. */
+    /** Number of results to skip from the beginning of the result set. */
     skip?: number;
-    /** Limit the number of resulting documents. */
+    /** Maximum number of results to return. */
     limit?: number;
 }
 export interface AggregatePipelineDataItemsResponse {