@wix/bex-utils 2.115.0 → 2.116.0

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/cloud/data/api/data/message/aggregate-pipeline.proto

@@ -0,0 +1,528 @@
+//flynt-disable package-matches-structure
+//flynt-disable fields-order-change-not-allowed
+//flynt-disable field-type-breaking-change
+//flynt-disable renamed-field-breaking-change
+
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api.data;
+
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/struct.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "com/wixpress/cloud/data/api/common.proto";
+import "com/wixpress/cloud/data/api/data/message/options.proto";
+import "com/wixpress/cloud/data/api/data/upstream/wix/common/paging.proto";
+import "com/wixpress/cloud/data/api/data/upstream/wix/common/sorting.proto";
+
+message AggregatePipelineDataItemsRequest {
+  message Expression {
+    message AddOperation {
+      // Expressions to add together.
+      //
+      // All expressions must resolve to numbers.
+      repeated Expression expressions = 1 [(wix.api.maxSize) = 1000];
+    }
+
+    message SumOperation {
+      // Expressions to calculate the total sum of.
+      //
+      // All expressions must resolve to numbers.
+      repeated Expression expressions = 1 [(wix.api.maxSize) = 1000];
+    }
+
+    message SubtractOperation {
+      // Expression to subtract `secondExpression` from. 
+      //
+      // Expression must resolve to a number.
+      Expression first_expression = 1;
+      // Expression to subtract from `firstExpression`. 
+      //
+      // Expression must resolve to a number.
+      Expression second_expression = 2;
+    }
+
+    message MultiplyOperation {
+      // Expressions to multiply.
+      //
+      // All expressions must resolve to numbers.
+      repeated Expression expressions = 1 [(wix.api.maxSize) = 1000];
+    }
+
+    message DivideOperation {
+      // Expression to divide by `secondExpression`.
+      //
+      // Expression must resolve to a number.
+      Expression first_expression = 1;
+      // Expression to divide `firstExpression` by.
+      //
+      // Expression must resolve to a non-zero number.
+      Expression second_expression = 2;
+    }
+
+    message ModOperation {
+      // Expression to divide by `secondExpression` to find the remainder.
+      //
+      // Expression must resolve to a number.
+      Expression first_expression = 1;
+      // Expression to divide `firstExpression` by.
+      //
+      // Expression must resolve to a non-zero number.
+      Expression second_expression = 2;
+    }
+
+    message AbsOperation {
+      // Expression to find the absolute value of.
+      //
+      // Expression must resolve to a number.
+      Expression expression = 1;
+    }
+
+    message FloorOperation {
+      // Expression to round down to the nearest whole number.
+      //
+      // Expression must resolve to a number.
+      Expression expression = 1;
+    }
+
+    message CeilOperation {
+      // Expression to round up to the nearest whole number.
+      //
+      // Expression must resolve to a number.
+      Expression expression = 1;
+    }
+
+    message ConcatOperation {
+      // Expressions to join together.
+      //
+      // All expressions must resolve to strings.
+      repeated Expression expressions = 1 [(wix.api.maxSize) = 1000];
+    }
+
+    message StringifyOperation {
+      // Expression to convert to a string.
+      Expression expression = 1;
+    }
+
+    message ToLowerOperation {
+      // Expression to convert to lowercase.
+      //
+      // Expression must resolve to a string.
+      Expression expression = 1;
+    }
+
+    message ToUpperOperation {
+      // Expression to convert to uppercase.
+      //
+      // Expression must resolve to a string.
+      Expression expression = 1;
+    }
+
+    message SubstringOperation {
+      // Expression to extract a substring from.
+      //
+      // Expression must resolve to a string.
+      Expression expression = 1;
+      // Starting position of the substring to extract, specified in zero-based indexing. 
+      //
+      // Expression must resolve to a number.
+      Expression start_expression = 2;
+      // Number of characters to extract from the starting position.
+      //
+      // Expression must resolve to a number.
+      Expression length_expression = 3;
+    }
+
+    message LengthOperation {
+      // Expression to count the total number of characters of.
+      //
+      // Expression must resolve to a string.
+      Expression expression = 1;
+    }
+
+    message ConditionOperation {
+      // Expression to evaluate as a condition.
+      Expression if_expression = 1;
+      // Expression to return when `ifExpression` resolves to `true`.
+      Expression when_true = 2;
+      // Expression to return when `ifExpression` resolves to `false`.
+      Expression when_false = 3;
+    }
+
+    message GreaterThanOperation {
+      // Expression on the left side of the comparison.
+      Expression first_expression = 1;
+      // Expression on the right side of the comparison.
+      Expression second_expression = 2;
+    }
+
+    message SizeOperation {
+      // Expression containing the array whose size to return.
+      Expression expression = 1;
+    }
+
+    oneof value {
+      // Path to the field containing the value to resolve. 
+      //
+      // Use dot notation to specify nested fields. For example, `user.name` or `product.price`.
+      string field_path = 1 [(wix.api.maxLength) = 1000];
+      // Text value.
+      string text = 2 [(wix.api.maxLength) = 1000];
+      // Number value.
+      double numeric = 3;
+      // Adds the specified expressions together.
+      AddOperation add = 4;
+      // Calculates the total sum of multiple expressions.
+      SumOperation sum = 5;
+      // Subtracts 1 expression from another.
+      SubtractOperation subtract = 6;
+      // Multiplies multiple expressions together.
+      MultiplyOperation multiply = 7;
+      // Divides 1 expression by another.
+      DivideOperation divide = 8;
+      // Finds the absolute value of an expression.
+      AbsOperation abs = 9;
+      // Finds the remainder when dividing 1 expression by another.
+      ModOperation mod = 10;
+      // Rounds an expression down to the nearest whole number.
+      FloorOperation floor = 11;
+      // Rounds an expression up to the nearest whole number.
+      CeilOperation ceil = 12;
+      // Joins multiple expressions together to create a string.
+      ConcatOperation concat = 13;
+      // Converts an expression to a string.
+      StringifyOperation stringify = 14;
+      // Converts an expression to lowercase.
+      ToLowerOperation to_lower = 15;
+      // Converts an expression to uppercase.
+      ToUpperOperation to_upper = 16;
+      // Extracts a portion of a string expression.
+      SubstringOperation substring = 17;
+      // Finds the length of a string expression.
+      LengthOperation length = 18;
+      // Boolean value.
+      bool boolean = 19 [(wix.api.field_exposure) = PRIVATE];
+      // Returns one of two expressions based on a condition.
+      ConditionOperation condition = 20 [(wix.api.field_exposure) = PRIVATE];
+      // Checks whether the first expression is greater than the second expression.
+      GreaterThanOperation gt = 21 [(wix.api.field_exposure) = PRIVATE];
+      // Returns the number of elements in an array expression.
+      SizeOperation size = 22 [(wix.api.field_exposure) = PRIVATE];
+    }
+  }
+
+  message Accumulator {
+
+    message Avg {
+      // Expression to calculate the group's average value.
+      //
+      // Expression must resolve to a number.
+      Expression expression = 1;
+    }
+
+    message Min {
+      // Expression to find the group's minimum value.
+      //
+      // Expression must resolve to a comparable value, such as a number or string.
+      Expression expression = 1;
+    }
+
+    message Max {
+      // Expression to find the group's maximum value.
+      //
+      // Expression must resolve to a comparable value, such as a number or string.
+      Expression expression = 1;
+    }
+
+    message Sum {
+      // Expression to calculate the group's total sum.
+      //
+      // Expression must resolve to a number.
+      Expression expression = 1;
+    }
+
+    message First {
+      // Expression to find the first item in the group.
+      Expression expression = 1;
+    }
+
+    message Last {
+      // Expression to find the last item in the group.
+      Expression expression = 1;
+    }
+
+    message Push {
+      // Expression to collect items into an array.
+      Expression expression = 1;
+    }
+
+    // Field key in the output item to store the result in.
+    string result_field_name = 1 [(wix.api.maxLength) = 1000];
+    
+    oneof expression {
+      // Calculates the average value across all items in the group based on the specified expression.
+      Avg avg = 2;
+      // Finds the minimum value across all items in the group.
+      Min min = 3;
+      // Finds the maximum value across all items in the group.
+      Max max = 4;
+      // Calculates the sum of the specified expression across all items in the group.
+      Sum sum = 5;
+      // Finds the first item in the group.
+      First first = 6;
+      // Finds the last item in the group.
+      Last last = 7;
+      // Collects values from all items in the group into an array.
+      Push push = 8;
+    }
+  }
+
+   // Transforms collection items by including, excluding, or reshaping fields.
+  message Projection {
+    message Field {
+      oneof projection {
+        // When specified, includes only the specified field in the result. All other fields are excluded.
+        Include include = 1;
+        // When specified, excludes the specified field from the result. All other fields are included.
+        Exclude exclude = 2;
+        // Reshapes a new field based on the specified expression. The field used by the expression is not included in the result.
+        Reshape reshape = 3;
+        // Creates nested fields by including, excluding, or reshaping fields.
+        ProjectNested project_nested = 4;
+      }
+    }
+
+    message Include {
+      // Key of the field to include in the result.
+      //
+      // 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).
+      string field_name = 1 [(wix.api.maxLength) = 1000];
+    }
+
+    message Exclude {
+      // Key of the field to exclude from the result.
+      //
+      // 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).
+      string field_name = 1 [(wix.api.maxLength) = 1000];
+    }
+
+    message Reshape {
+      // 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).
+      string result_field_name = 1 [(wix.api.maxLength) = 1000];
+      // Expression to resolve. The result of the expression becomes the value of the new field.
+      Expression expression = 2;
+    }
+
+    message ProjectNested {
+      // 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).
+      string result_field_name = 1 [(wix.api.maxLength) = 1000];
+      // Nested fields to include, exclude, or reshape.
+      repeated Field fields = 2 [(wix.api.maxSize) = 1000];
+    }
+
+    // Fields to include, exclude, or reshape.
+    repeated Field fields = 1 [(wix.api.maxSize) = 1000];
+  }
+
+  // Converts an object to an array.
+  message ObjectToArray {
+    // Key of the object field to convert to an array.
+    //
+    // 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).
+    string object_field_name = 1 [(wix.api.maxLength) = 1000];
+    // 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).
+    string destination_field_name = 2 [(wix.api.maxLength) = 1000];
+  }
+
+  // Unwinds an array.
+  message UnwindArray {
+    // Key of the array field to unwind.
+    //
+    // 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).
+    string array_field_name = 1 [(wix.api.maxLength) = 1000];
+  }
+
+  message Group {
+    message GroupId {
+      // Name of the field to group items by.
+      //
+      // This becomes the field name in the result's `_id` property.
+      string key = 1 [(wix.api.maxLength) = 1000];
+      // 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 = 2;
+    }
+    // Grouping criteria by which to organize items.
+    //
+    // Each `groupId` specifies a field by which to group items, and serves as the result item's unique `_id` property. 
+    //
+    // 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.
+    repeated GroupId group_ids = 1 [(wix.api.maxSize) = 1000];
+    // 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 be compatible with the operation type. For example, when using the `sum` accumulator, the specified expression must resolve to a number.
+    repeated Accumulator accumulators = 2 [(wix.api.maxSize) = 1000];
+  }
+
+  message Sorting {
+    // Fields to sort the results by.
+    repeated upstream.wix.common.Sorting values = 1 [(wix.api.maxSize) = 1000];
+  }
+
+  message AddFields {
+    message AddField {
+      // Key of the field to add or replace in the result item.
+      string field_name = 1 [(wix.api.maxLength) = 1000];
+      // Expression to resolve. The result of the expression becomes the value of the field.
+      Expression expression = 2;
+    }
+
+    // Fields to add or replace in the result items.
+    repeated AddField fields = 1 [(wix.api.maxSize) = 1000];
+  }
+
+  message Lookup {
+    // ID of the collection to join with.
+    string data_collection_id = 1 [(wix.api.maxLength) = 256];
+    // Key of the local field whose value is used for matching items in the joined collection.
+    string local_field = 2 [(wix.api.maxLength) = 1000];
+    // Key of the field in the joined collection to match against the local field value.
+    string foreign_field = 3 [(wix.api.maxLength) = 1000];
+    // Key of the array field where matching joined items are stored.
+    string as_field = 4 [(wix.api.maxLength) = 1000];
+  }
+
+  message UnionWith {
+    // ID of the collection whose results are appended to the current pipeline results.
+    string data_collection_id = 1 [(wix.api.maxLength) = 256];
+    // Pipeline to run on the union collection before appending its results.
+    AggregationPipeline pipeline = 2;
+  }
+
+  message 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.
+    repeated Stage stages = 1 [(wix.api.maxSize) = 100];
+
+    oneof paging_method {
+      // 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).
+      upstream.wix.common.Paging paging = 2;
+
+      // Cursor token referring to a page of results.
+      //
+      // Not used in the first request. Subsequent requests use the cursor token and not `filter` or `sort`.
+      upstream.wix.common.CursorPaging cursor_paging = 3;
+    }
+  }
+
+  message Stage {
+    oneof stage {
+
+      // Groups aggregated items to new result items.
+      Group group = 1;
+
+      // Aggregation filter. Only 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).
+      google.protobuf.Struct filter = 2;
+
+      // Sorting preferences.
+      //
+      // Learn more about [sorting and paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging).
+      Sorting sort = 3;
+
+      // Transforms items by including, excluding, or reshaping fields.
+      Projection projection = 4;
+
+      // Transforms an object into an array where each object property becomes a new array element containing the property's key and value, as well as all other properties from the original object.
+      ObjectToArray object_to_array = 5;
+
+      // Creates a result item for each array element. Each result contains the full original item, with the array field replaced by an element whose key is the array name and whose value is the array element.
+      UnwindArray unwind_array = 6;
+
+      // Number of results to skip from the beginning of the result set.
+      int32 skip = 7;
+
+      // Maximum number of results to return.
+      int32 limit = 8;
+
+      // Adds or replaces fields in each result item.
+      AddFields add_fields = 9 [(wix.api.field_exposure) = PRIVATE];
+
+      // Joins items from another collection into an array field by matching a local field against a foreign field.
+      Lookup lookup = 10 [(wix.api.field_exposure) = PRIVATE];
+
+      // Appends results from another collection pipeline to the current results.
+      UnionWith union_with = 11 [(wix.api.field_exposure) = PRIVATE];
+    }
+  }
+
+  
+  // Environment: `LIVE` or `SANDBOX`.
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection to run the aggregation pipeline on.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // Aggregation pipeline configuration containing stages and paging options.
+  AggregationPipeline pipeline = 3;
+
+  // 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`.
+  bool return_total_count = 4;
+
+  // Grid app ID. Optional in Live segment.
+  google.protobuf.StringValue app_id = 5 [(wix.api.format) = GUID, (wix.api.field_exposure) = PRIVATE];
+
+  // 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`.
+  bool consistent_read = 6;
+
+  // Language to run the aggregation in, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
+  //
+  // When provided, the aggregation runs on items in the specified language. When not provided, the aggregation runs on items in the default language.
+  //
+  // > **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).
+  google.protobuf.StringValue language = 7 [(wix.api.format) = LANGUAGE_TAG];
+
+  // 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.
+  //
+  // Learn more about [querying Wix app collections](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-app-collections/querying-wix-app-collections).
+  google.protobuf.Struct app_options = 8;
+
+  // 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 aren't.
+  PublishPluginOptions publish_plugin_options = 9;
+}
+
+message AggregatePipelineDataItemsResponse {
+  // Aggregation results.
+  repeated google.protobuf.Struct results = 1 [(wix.api.maxSize) = 10000];
+
+  // Paging information.
+  upstream.wix.common.PagingMetadataV2 paging_metadata = 2;
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/cloud/data/api/data/message/aggregate.proto

@@ -0,0 +1,146 @@
+//flynt-disable no-oneof-empty-markers
+
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api.data;
+
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/struct.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "com/wixpress/cloud/data/api/common.proto";
+import "com/wixpress/cloud/data/api/data/message/options.proto";
+import "com/wixpress/cloud/data/api/data/upstream/wix/common/paging.proto";
+import "com/wixpress/cloud/data/api/data/upstream/wix/common/sorting.proto";
+
+message AggregateDataItemsRequest {
+  message Aggregation {
+    message Operation {
+      message Average {
+        // Name of the field for which to calculate the average value.
+        string item_field_name = 1 [(wix.api.maxLength) = 1000];
+      }
+      message Min {
+        // Name of the field for which to calculate the minimum value.
+        string item_field_name = 1 [(wix.api.maxLength) = 1000];
+      }
+      message Max {
+        // Name of the field for which to calculate the maximum value.
+        string item_field_name = 1 [(wix.api.maxLength) = 1000];
+      }
+      message Sum {
+        // Name of the field for which to calculate the sum.
+        string item_field_name = 1 [(wix.api.maxLength) = 1000];
+      }
+      message Count {}
+
+      // Name of the field containing results of the operation.
+      string result_field_name = 1 [(wix.api.maxLength) = 1000];
+
+      oneof calculate {
+        // Calculate the average value of a specified field for all items in the grouping.
+        Average average = 2;
+
+        // Calculate the minimum value of a specified field for all items in the grouping.
+        Min min = 3;
+
+        // Calculate the maximum value of a specified field for all items in the grouping.
+        Max max = 4;
+
+        // Calculate the sum of values of a specified field for all items in the grouping.
+        Sum sum = 5;
+
+        // Calculate the number of items in the grouping.
+        Count item_count = 6;
+      }
+    }
+    // Fields by which to group items for the aggregation. If empty, the aggregation is carried out on all items in the collection.
+    repeated string grouping_fields = 1 [(wix.api.maxSize) = 100, (wix.api.maxLength) = 1000];
+    // Operations to carry out on the data in each grouping.
+    repeated Operation operations = 2 [(wix.api.maxSize) = 100];
+  }
+
+  // Environment: LIVE or SANDBOX
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection on which to run the aggregation.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // Filter applied to the collection's data prior to running the aggregation. 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.
+  //
+  // **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).
+  google.protobuf.Struct initial_filter = 3;
+
+  // Aggregation applied to the data.
+  Aggregation aggregation = 4;
+
+  // Filter applied to the processed data following the aggregation. 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.
+  // **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).
+  google.protobuf.Struct final_filter = 5;
+
+  oneof paging_method {
+    // Paging options to limit and skip the number of items.
+    upstream.wix.common.Paging paging = 6;
+
+    // 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`.
+    upstream.wix.common.CursorPaging cursor_paging = 7;
+  }
+
+  // Sort object in the following format:
+  // `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+  repeated upstream.wix.common.Sorting sort = 8 [(wix.api.maxSize) = 100];
+
+  // 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.
+  //
+  // Default: `false`
+  bool return_total_count = 9;
+
+  // Grid app id. Optional in Live segment.
+  google.protobuf.StringValue app_id = 10 [(wix.api.format) = GUID, (wix.api.field_exposure) = PRIVATE];
+
+  // Data access options
+  Options options = 11 [
+    (wix.api.field_exposure) = PRIVATE,
+    deprecated = true,
+    (wix.api.field_deprecated) = {
+      replaced_by: "inlined"
+      target_removal_date: "2024-07-12"
+    }
+  ];
+
+  // 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`
+  bool consistent_read = 12;
+
+  // Language to run the aggregation on, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
+  //
+  // If not provided, the aggregation runs on items in the default language.
+  //
+  // > **Note:** The site must have [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual) installed, and translation for the specified language must be enabled for the collection.
+  //
+  // Learn more about [Using Wix Multilingual to Translate CMS Content](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content).
+  google.protobuf.StringValue language = 13 [(wix.api.format) = LANGUAGE_TAG];
+  
+  // 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`.
+  google.protobuf.Struct app_options = 14;
+
+  // 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.  
+  PublishPluginOptions publish_plugin_options = 15;
+}
+
+message AggregateDataItemsResponse {
+  // Aggregation results.
+  repeated google.protobuf.Struct results = 1;
+
+  // Paging information.
+  upstream.wix.common.PagingMetadataV2 paging_metadata = 3;
+}