@wix/wix-data-items-common 1.0.207 → 1.0.209

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

@@ -1589,19 +1589,13 @@ export interface SearchDataItemsResponse {
     /** Paging information. */
     pagingMetadata?: PagingMetadataV2;
 }
-export interface AggregatePipelineDataItemsRequest extends AggregatePipelineDataItemsRequestPagingMethodOneOf {
-    /**
-     * 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 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 AggregateDataItemsResponse {
+    /** Aggregation results. */
+    results?: Record<string, any>[] | null;
+    /** Paging information. */
+    pagingMetadata?: PagingMetadataV2;
+}
+export interface AggregatePipelineDataItemsRequest {
     /**
      * Environment: `LIVE` or `SANDBOX`.
      * @internal
@@ -1612,21 +1606,14 @@ export interface AggregatePipelineDataItemsRequest extends AggregatePipelineData
      * @maxLength 256
      */
     dataCollectionId: string;
+    /** Aggregation pipeline configuration containing stages and paging options. */
+    pipeline?: AggregationPipeline;
     /**
-     * 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 result count when running a query with offset paging.
-     *
-     * When `true`, the `pagingMetadata` property 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`
+     * Default: `false`.
      */
     returnTotalCount?: boolean;
     /**
@@ -1642,7 +1629,7 @@ export interface AggregatePipelineDataItemsRequest extends AggregatePipelineData
      *
      * Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
      *
-     * Default: `false`
+     * Default: `false`.
      */
     consistentRead?: boolean;
     /**
@@ -1650,9 +1637,9 @@ export interface AggregatePipelineDataItemsRequest extends AggregatePipelineData
      *
      * 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).
+     * > **Note:** The Wix user must enable translation for the specified language 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).
+     * 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;
@@ -1669,26 +1656,11 @@ export interface AggregatePipelineDataItemsRequest extends AggregatePipelineData
      */
     publishPluginOptions?: DataPublishPluginOptions;
 }
-/** @oneof */
-export interface AggregatePipelineDataItemsRequestPagingMethodOneOf {
-    /**
-     * 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 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 {
     /**
-     * Path to the field that contains the value to use in the expression.
+     * Path to the field containing the value to resolve.
      *
-     * Use dot notation to specify nested fields, such as `user.name` or `product.price`.
+     * Use dot notation to specify nested fields. For example, `user.name` or `product.price`.
      * @maxLength 1000
      */
     fieldPath?: string;
@@ -1697,7 +1669,7 @@ export interface Expression extends ExpressionValueOneOf {
      * @maxLength 1000
      */
     text?: string;
-    /** Numeric value. */
+    /** Number value. */
     numeric?: number;
     /** Adds the specified expressions together. */
     add?: AddOperation;
@@ -1717,13 +1689,13 @@ export interface Expression extends ExpressionValueOneOf {
     floor?: FloorOperation;
     /** Rounds an expression up to the nearest whole number. */
     ceil?: CeilOperation;
-    /** Joins multiple expressions together to create a new string. */
+    /** Joins multiple expressions together to create a string. */
     concat?: ConcatOperation;
-    /** Converts an expression into a string. */
+    /** Converts an expression to a string. */
     stringify?: StringifyOperation;
-    /** Converts an expression into lowercase. */
+    /** Converts an expression to lowercase. */
     toLower?: ToLowerOperation;
-    /** Converts an expression into uppercase. */
+    /** Converts an expression to uppercase. */
     toUpper?: ToUpperOperation;
     /** Extracts a portion of a string expression. */
     substring?: SubstringOperation;
@@ -1733,9 +1705,9 @@ export interface Expression extends ExpressionValueOneOf {
 /** @oneof */
 export interface ExpressionValueOneOf {
     /**
-     * Path to the field that contains the value to use in the expression.
+     * Path to the field containing the value to resolve.
      *
-     * Use dot notation to specify nested fields, such as `user.name` or `product.price`.
+     * Use dot notation to specify nested fields. For example, `user.name` or `product.price`.
      * @maxLength 1000
      */
     fieldPath?: string;
@@ -1744,7 +1716,7 @@ export interface ExpressionValueOneOf {
      * @maxLength 1000
      */
     text?: string;
-    /** Numeric value. */
+    /** Number value. */
     numeric?: number;
     /** Adds the specified expressions together. */
     add?: AddOperation;
@@ -1764,13 +1736,13 @@ export interface ExpressionValueOneOf {
     floor?: FloorOperation;
     /** Rounds an expression up to the nearest whole number. */
     ceil?: CeilOperation;
-    /** Joins multiple expressions together to create a new string. */
+    /** Joins multiple expressions together to create a string. */
     concat?: ConcatOperation;
-    /** Converts an expression into a string. */
+    /** Converts an expression to a string. */
     stringify?: StringifyOperation;
-    /** Converts an expression into lowercase. */
+    /** Converts an expression to lowercase. */
     toLower?: ToLowerOperation;
-    /** Converts an expression into uppercase. */
+    /** Converts an expression to uppercase. */
     toUpper?: ToUpperOperation;
     /** Extracts a portion of a string expression. */
     substring?: SubstringOperation;
@@ -1813,7 +1785,7 @@ export interface MultiplyOperation {
     /**
      * Expressions to multiply.
      *
-     * Expressions must resolve to numbers.
+     * All expressions must resolve to numbers.
      * @maxSize 1000
      */
     expressions?: Expression[];
@@ -1842,7 +1814,7 @@ export interface AbsOperation {
 }
 export interface ModOperation {
     /**
-     * Expression to divide by `secondExpression`.
+     * Expression to divide by `secondExpression` to find the remainder.
      *
      * Expression must resolve to a number.
      */
@@ -1874,13 +1846,13 @@ export interface ConcatOperation {
     /**
      * Expressions to join together.
      *
-     * Expressions must resolve to strings.
+     * All expressions must resolve to strings.
      * @maxSize 1000
      */
     expressions?: Expression[];
 }
 export interface StringifyOperation {
-    /** Expression to convert into a string. */
+    /** Expression to convert to a string. */
     expression?: Expression;
 }
 export interface ToLowerOperation {
@@ -1907,7 +1879,7 @@ export interface SubstringOperation {
      */
     expression?: Expression;
     /**
-     * Starting position of the substring to extract. Use zero-based indexing.
+     * Starting position of the substring to extract, specified in zero-based indexing.
      *
      * Expression must resolve to a number.
      */
@@ -1921,7 +1893,7 @@ export interface SubstringOperation {
 }
 export interface LengthOperation {
     /**
-     * Expression to calculate the character count of.
+     * Expression to count the total number of characters of.
      *
      * Expression must resolve to a string.
      */
@@ -1929,7 +1901,7 @@ export interface LengthOperation {
 }
 export interface Avg {
     /**
-     * Expression by which to calculate the group's average value.
+     * Expression to calculate the group's average value.
      *
      * Expression must resolve to a number.
      */
@@ -1937,7 +1909,7 @@ export interface Avg {
 }
 export interface AccumulatorMin {
     /**
-     * Expression by which to find the group's minimum value.
+     * Expression to find the group's minimum value.
      *
      * Expression must resolve to a comparable value, such as a number or string.
      */
@@ -1945,7 +1917,7 @@ export interface AccumulatorMin {
 }
 export interface AccumulatorMax {
     /**
-     * Expression by which to find the group's maximum value.
+     * Expression to find the group's maximum value.
      *
      * Expression must resolve to a comparable value, such as a number or string.
      */
@@ -1953,29 +1925,29 @@ export interface AccumulatorMax {
 }
 export interface AccumulatorSum {
     /**
-     * Expression by which to calculate the group's total sum.
+     * Expression to calculate the group's total sum.
      *
      * Expression must resolve to a number.
      */
     expression?: Expression;
 }
 export interface First {
-    /** Expression by which to find the first item in the group. */
+    /** Expression to find the first item in the group. */
     expression?: Expression;
 }
 export interface Last {
-    /** Expression by which to find the last item in the group. */
+    /** Expression to find the last item in the group. */
     expression?: Expression;
 }
 export interface Push {
-    /** Expression by which to collect items into an array. */
+    /** Expression to collect items into an array. */
     expression?: Expression;
 }
 export interface Include {
     /**
      * 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).
+     * Use dot notation to specify nested fields. For example, `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;
@@ -1984,7 +1956,7 @@ export interface Exclude {
     /**
      * 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).
+     * Use dot notation to specify nested fields. For example, `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;
@@ -1997,7 +1969,7 @@ export interface Reshape {
      * @maxLength 1000
      */
     resultFieldName?: string;
-    /** Expression to resolve. The result of the expression is the value of the new field. */
+    /** Expression to resolve. The result of the expression becomes the value of the new field. */
     expression?: Expression;
 }
 export interface ProjectNested {
@@ -2009,7 +1981,7 @@ export interface ProjectNested {
      */
     resultFieldName?: string;
     /**
-     * Nested fields to include, exclude, or calculate by running aggregations.
+     * Nested fields to include, exclude, or reshape.
      * @maxSize 1000
      */
     fields?: Field[];
@@ -2019,9 +1991,9 @@ export interface Field extends FieldProjectionOneOf {
     include?: Include;
     /** When specified, excludes the specified field from the result. All other fields are included. */
     exclude?: Exclude;
-    /** Reshape a new field based on the specified expression. */
+    /** Reshapes a new field based on the specified expression. */
     reshape?: Reshape;
-    /** Project nested fields by including, excluding, or reshaping new fields. */
+    /** Creates nested fields by including, excluding, or reshaping fields. */
     projectNested?: ProjectNested;
 }
 /** @oneof */
@@ -2030,9 +2002,9 @@ export interface FieldProjectionOneOf {
     include?: Include;
     /** When specified, excludes the specified field from the result. All other fields are included. */
     exclude?: Exclude;
-    /** Reshape a new field based on the specified expression. */
+    /** Reshapes a new field based on the specified expression. */
     reshape?: Reshape;
-    /** Project nested fields by including, excluding, or reshaping new fields. */
+    /** Creates nested fields by including, excluding, or reshaping fields. */
     projectNested?: ProjectNested;
 }
 export interface GroupId {
@@ -2043,11 +2015,11 @@ export interface GroupId {
      * @maxLength 1000
      */
     key?: string;
-    /** 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 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 {
-    /** Calculates the average value across all items in the group, based on the specified expression. */
+    /** Calculates the average value across all items in the group based on the specified expression. */
     avg?: Avg;
     /** Finds the minimum value across all items in the group. */
     min?: AccumulatorMin;
@@ -2069,7 +2041,7 @@ export interface Accumulator extends AccumulatorExpressionOneOf {
 }
 /** @oneof */
 export interface AccumulatorExpressionOneOf {
-    /** Calculates the average value across all items in the group, based on the specified expression. */
+    /** Calculates the average value across all items in the group based on the specified expression. */
     avg?: Avg;
     /** Finds the minimum value across all items in the group. */
     min?: AccumulatorMin;
@@ -2084,11 +2056,84 @@ export interface AccumulatorExpressionOneOf {
     /** Collects values from all items in the group into an array. */
     push?: Push;
 }
+export interface Stage extends StageStageOneOf {
+    /** Groups aggregated items to new result items. */
+    group?: Group;
+    /**
+     * Aggregation filter. Only collection items that match the filter are processed.
+     *
+     * 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;
+    /**
+     * Sorting preferences.
+     *
+     * Learn more about [sorting and paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging).
+     */
+    sort?: AggregatePipelineDataItemsRequestSorting;
+    /** Transforms collection items by including, excluding, or reshaping fields. */
+    projection?: Projection;
+    /**
+     * Converts an object to an array.
+     *
+     * Each property becomes an element in the new array that includes all other fields from the original object.
+     */
+    objectToArray?: ObjectToArray;
+    /**
+     * Unwinds an array into separate result items.
+     *
+     * Creates a new result object for each array element. Each new object contains the array element's value and all other fields from the original object.
+     */
+    unwindArray?: UnwindArray;
+    /** Number of results to skip from the beginning of the result set. */
+    skip?: number;
+    /** Maximum number of results to return. */
+    limit?: number;
+}
+/** @oneof */
+export interface StageStageOneOf {
+    /** Groups aggregated items to new result items. */
+    group?: Group;
+    /**
+     * Aggregation filter. Only collection items that match the filter are processed.
+     *
+     * 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;
+    /**
+     * Sorting preferences.
+     *
+     * Learn more about [sorting and paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging).
+     */
+    sort?: AggregatePipelineDataItemsRequestSorting;
+    /** Transforms collection items by including, excluding, or reshaping fields. */
+    projection?: Projection;
+    /**
+     * Converts an object to an array.
+     *
+     * Each property becomes an element in the new array that includes all other fields from the original object.
+     */
+    objectToArray?: ObjectToArray;
+    /**
+     * Unwinds an array into separate result items.
+     *
+     * Creates a new result object for each array element. Each new object contains the array element's value and all other fields from the original object.
+     */
+    unwindArray?: UnwindArray;
+    /** Number of results to skip from the beginning of the result set. */
+    skip?: number;
+    /** Maximum number of results to return. */
+    limit?: number;
+}
 export interface Group {
     /**
      * 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.
+     * Each `groupId` 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
@@ -2111,20 +2156,20 @@ export interface AggregatePipelineDataItemsRequestSorting {
      */
     values?: Sorting[];
 }
-/** Transform individual collection items by including, excluding, or calculating new fields based on aggregations. */
+/** Transforms collection items by including, excluding, or reshaping fields. */
 export interface Projection {
     /**
-     * Nested fields to include, exclude, or calculate by running aggregations.
+     * Fields to include, exclude, or reshape.
      * @maxSize 1000
      */
     fields?: Field[];
 }
-/** Convert an object into an array. */
+/** Converts an object to an array. */
 export interface ObjectToArray {
     /**
-     * Key of the field to convert into an array.
+     * Key of the object field to convert to 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).
+     * Use dot notation to specify nested fields. For example, `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
      */
     objectFieldName?: string;
@@ -2136,88 +2181,51 @@ export interface ObjectToArray {
      */
     destinationFieldName?: string;
 }
-/** Unwind an array. */
+/** Unwinds an array. */
 export interface UnwindArray {
     /**
      * 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).
+     * Use dot notation to specify a nested array. For example, `user.products` or `product.colors`. 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 {
+export interface AggregationPipeline extends AggregationPipelinePagingMethodOneOf {
     /**
-     * Group.
-     *
-     * Groups aggregate data across multiple collection items and create new result items.
-     */
-    group?: Group;
-    /**
-     * Aggregation filter. Only collection items that match the filter are processed.
-     *
-     * Learn more about [filters in API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language#filters).
+     * Paging options to limit and skip the number of results.
      *
-     * > **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).
+     * Learn more about [sorting and paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging).
      */
-    filter?: Record<string, any> | null;
+    paging?: Paging;
     /**
-     * Sorting preferences.
+     * Cursor token referring to a page of results.
      *
-     * Learn more about [sorting and paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging).
+     * Not used in the first request. Subsequent requests use the cursor token and not `filter` or `sort`.
      */
-    sort?: AggregatePipelineDataItemsRequestSorting;
-    /** Transform collection items by including, excluding, or calculating new fields. */
-    projection?: Projection;
-    /** 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;
+    cursorPaging?: CursorPaging;
     /**
-     * Deconstructs an array field into separate result items.
+     * Sequence of aggregation operations to apply to the data.
      *
-     * 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.
+     * Stages are processed in order, with each stage operating on the output of the previous stage.
+     * @maxSize 100
      */
-    unwindArray?: UnwindArray;
-    /** Number of results to skip from the beginning of the result set. */
-    skip?: number;
-    /** Maximum number of results to return. */
-    limit?: number;
+    stages?: Stage[];
 }
 /** @oneof */
-export interface StageStageOneOf {
-    /**
-     * Group.
-     *
-     * Groups aggregate data across multiple collection items and create new result items.
-     */
-    group?: Group;
+export interface AggregationPipelinePagingMethodOneOf {
     /**
-     * Aggregation filter. Only collection items that match the filter are processed.
-     *
-     * 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;
-    /**
-     * Sorting preferences.
+     * 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).
      */
-    sort?: AggregatePipelineDataItemsRequestSorting;
-    /** Transform collection items by including, excluding, or calculating new fields. */
-    projection?: Projection;
-    /** 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;
+    paging?: Paging;
     /**
-     * Deconstructs an array field into separate result items.
+     * Cursor token referring to a page of results.
      *
-     * 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.
+     * Not used in the first request. Subsequent requests use the cursor token and not `filter` or `sort`.
      */
-    unwindArray?: UnwindArray;
-    /** Number of results to skip from the beginning of the result set. */
-    skip?: number;
-    /** Maximum number of results to return. */
-    limit?: number;
+    cursorPaging?: CursorPaging;
 }
 export interface AggregatePipelineDataItemsResponse {
     /**