IBX-6702: BasePriceStatsAggregation and CustomPriceStatsAggregation described (#2252)

* BasePriceStatsAggregation and CustomPriceStatsAggregation described

* Type updated

* Vale fix

* Fixes after review

* Update custompricestats_aggregation.md

Co-authored-by: Adam Wójs <[email protected]>

---------

Co-authored-by: Adrien Dupuis <[email protected]>
Co-authored-by: Adam Wójs <[email protected]>

Author: 3 people

docs/search/aggregation_reference/aggregation_reference.md

@@ -58,6 +58,8 @@ There are three types of aggregations:
 |Name | Type | Based on|
 |---|---|---|
 |[Product attribute](product_attribute_aggregations.md) | Term / Range | Product attribute values |
+|[BasePriceStats](basepricestats_aggregation.md) | Stats | Product base price |
+|[CustomPriceStats](custompricestats_aggregation.md) | Stats | Product custom price |
 |[ProductAvailabilityTerm](productavailabilityterm_aggregation.md) | Term | Product availability |
 |[ProductStockRange](productstockrange_aggregation.md) | Range | Product stock |
 |[ProductPriceRange](productpricerange_aggregation.md) | Range | Product price |

docs/search/aggregation_reference/basepricestats_aggregation.md

@@ -0,0 +1,24 @@
+# BasePriceStatsAggregation
+
+The BasePriceStatsAggregation aggregates search results by the value of the product's price
+and provides statistical information for the values. You can use the provided getters to access the values:
+
+- sum (`getSum()`)
+- count of values (`getCount()`)
+- minimum value (`getMin()`)
+- maximum value (`getMax()`)
+- average (`getAvg()`)
+
+## Arguments
+
+- `name` - name of the Aggregation
+- `\Ibexa\Contracts\ProductCatalog\Values\CurrencyInterface` - currency of the price
+
+## Example
+
+``` php
+$query = new ProductQuery();
+$query->setAggregations([
+    new BasePriceStatsAggregation('base_price_stats_aggregation', $currency),
+]);
+```

docs/search/aggregation_reference/custompricestats_aggregation.md

@@ -0,0 +1,25 @@
+# CustomPriceStatsAggregation
+
+The CustomPriceStatsAggregation aggregates search results by the value of the custom product's price
+and provides statistical information for the values. You can use the provided getters to access the values:
+
+- sum (`getSum()`)
+- count of values (`getCount()`)
+- minimum value (`getMin()`)
+- maximum value (`getMax()`)
+- average (`getAvg()`)
+
+## Arguments
+
+- `name` - name of the Aggregation
+- `\Ibexa\Contracts\ProductCatalog\Values\CurrencyInterface` - currency of the price
+- `\Ibexa\Contracts\ProductCatalog\Values\CustomerGroupInterface|null` - customer group that defines custom pricing, by default it is the one assigned to current user
+
+## Example
+
+``` php
+$query = new ProductQuery();
+$query->setAggregations([
+    new CustomPriceStatsAggregation('custom_price_stats_aggregation', $currency, $customerGroup),
+]);
+```

mkdocs.yml

@@ -675,6 +675,8 @@ nav:
             - IntegerStatsAggregation: search/aggregation_reference/integerstats_aggregation.md
             - KeywordTermAggregation: search/aggregation_reference/keywordterm_aggregation.md
             - Product attribute aggregations: search/aggregation_reference/product_attribute_aggregations.md
+            - BasePriceStatsAggregation: search/aggregation_reference/basepricestats_aggregation.md
+            - CustomPriceStatsAggregation: search/aggregation_reference/custompricestats_aggregation.md
             - ProductAvailabilityTermAggregation: search/aggregation_reference/productavailabilityterm_aggregation.md
             - ProductStockRangeAggregation: search/aggregation_reference/productstockrange_aggregation.md
             - ProductStockRangeAggregation: search/aggregation_reference/productstockrange_aggregation.md