fix(specs): value/price clarifications in the Insights API (#5154) (generated) [skip ci]

algolia-bot · kai687 · algolia-bot · commit e3c9fd43bb67 · 2025-07-22T10:31:55.000Z
Co-authored-by: Kai Welke &lt;kai.welke@algolia.com&gt;
diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/Price.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/Price.cs
@@ -15,7 +15,7 @@
 namespace Algolia.Search.Models.Insights;
 
 /// <summary>
-/// Total price of a product, including any discounts, in units of `currency`.
+/// Final price of a single product, including any discounts, in units of `currency`.
 /// </summary>
 [JsonConverter(typeof(PriceJsonConverter))]
 public partial class Price : AbstractSchema
diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/Value.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/Value.cs
@@ -15,7 +15,7 @@
 namespace Algolia.Search.Models.Insights;
 
 /// <summary>
-/// Total monetary value of this event in units of `currency`.
+/// Total monetary value of this event in units of `currency`. This should be equal to the sum of `price` times `quantity`.
 /// </summary>
 [JsonConverter(typeof(ValueJsonConverter))]
 public partial class Value : AbstractSchema
diff --git a/clients/algoliasearch-client-go/algolia/insights/model_price.go b/clients/algoliasearch-client-go/algolia/insights/model_price.go
diff --git a/clients/algoliasearch-client-go/algolia/insights/model_value.go b/clients/algoliasearch-client-go/algolia/insights/model_value.go
diff --git a/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/insights/Price.java b/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/insights/Price.java
@@ -11,7 +11,7 @@
 import java.io.IOException;
 import java.util.logging.Logger;
 
-/** Total price of a product, including any discounts, in units of `currency`. */
+/** Final price of a single product, including any discounts, in units of `currency`. */
 @JsonDeserialize(using = Price.Deserializer.class)
 public interface Price {
   // Price as Double wrapper.
diff --git a/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/insights/Value.java b/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/insights/Value.java
@@ -11,7 +11,10 @@
 import java.io.IOException;
 import java.util.logging.Logger;
 
-/** Total monetary value of this event in units of `currency`. */
+/**
+ * Total monetary value of this event in units of `currency`. This should be equal to the sum of
+ * `price` times `quantity`.
+ */
 @JsonDeserialize(using = Value.Deserializer.class)
 public interface Value {
   // Value as Double wrapper.
diff --git a/clients/algoliasearch-client-javascript/packages/client-insights/model/price.ts b/clients/algoliasearch-client-javascript/packages/client-insights/model/price.ts
@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Total price of a product, including any discounts, in units of `currency`.
+ * Final price of a single product, including any discounts, in units of `currency`.
  */
 export type Price = number | string;
diff --git a/clients/algoliasearch-client-javascript/packages/client-insights/model/value.ts b/clients/algoliasearch-client-javascript/packages/client-insights/model/value.ts
@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
- * Total monetary value of this event in units of `currency`.
+ * Total monetary value of this event in units of `currency`. This should be equal to the sum of `price` times `quantity`.
  */
 export type Value = number | string;
diff --git a/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/insights/Price.kt b/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/insights/Price.kt
@@ -11,7 +11,7 @@ import kotlinx.serialization.json.*
 import kotlin.jvm.JvmInline
 
 /**
- * Total price of a product, including any discounts, in units of `currency`.
+ * Final price of a single product, including any discounts, in units of `currency`.
  *
  * Implementations:
  * - [Double] - *[Price.of]*
diff --git a/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/insights/Value.kt b/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/insights/Value.kt
@@ -11,7 +11,7 @@ import kotlinx.serialization.json.*
 import kotlin.jvm.JvmInline
 
 /**
- * Total monetary value of this event in units of `currency`.
+ * Total monetary value of this event in units of `currency`. This should be equal to the sum of `price` times `quantity`.
  *
  * Implementations:
  * - [Double] - *[Value.of]*
diff --git a/clients/algoliasearch-client-php/lib/Model/Insights/Price.php b/clients/algoliasearch-client-php/lib/Model/Insights/Price.php
@@ -12,7 +12,7 @@
  *
  * @category Class
  *
- * @description Total price of a product, including any discounts, in units of `currency`.
+ * @description Final price of a single product, including any discounts, in units of `currency`.
  */
 class Price extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {
diff --git a/clients/algoliasearch-client-php/lib/Model/Insights/Value.php b/clients/algoliasearch-client-php/lib/Model/Insights/Value.php
@@ -12,7 +12,7 @@
  *
  * @category Class
  *
- * @description Total monetary value of this event in units of `currency`.
+ * @description Total monetary value of this event in units of `currency`. This should be equal to the sum of `price` times `quantity`.
  */
 class Value extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {
diff --git a/clients/algoliasearch-client-python/algoliasearch/insights/models/price.py b/clients/algoliasearch-client-python/algoliasearch/insights/models/price.py
@@ -20,7 +20,7 @@
 
 class Price(BaseModel):
     """
-    Total price of a product, including any discounts, in units of `currency`.
+    Final price of a single product, including any discounts, in units of `currency`.
     """
 
     oneof_schema_1_validator: Optional[float] = Field(default=None)
diff --git a/clients/algoliasearch-client-python/algoliasearch/insights/models/value.py b/clients/algoliasearch-client-python/algoliasearch/insights/models/value.py
@@ -20,7 +20,7 @@
 
 class Value(BaseModel):
     """
-    Total monetary value of this event in units of `currency`.
+    Total monetary value of this event in units of `currency`. This should be equal to the sum of `price` times `quantity`.
     """
 
     oneof_schema_1_validator: Optional[float] = Field(default=None)
diff --git a/clients/algoliasearch-client-ruby/lib/algolia/models/insights/price.rb b/clients/algoliasearch-client-ruby/lib/algolia/models/insights/price.rb
@@ -7,7 +7,7 @@
 
 module Algolia
   module Insights
-    # Total price of a product, including any discounts, in units of `currency`.
+    # Final price of a single product, including any discounts, in units of `currency`.
     module Price
       class << self
       # List of class defined in oneOf (OpenAPI v3)
diff --git a/clients/algoliasearch-client-ruby/lib/algolia/models/insights/value.rb b/clients/algoliasearch-client-ruby/lib/algolia/models/insights/value.rb
@@ -7,7 +7,7 @@
 
 module Algolia
   module Insights
-    # Total monetary value of this event in units of `currency`.
+    # Total monetary value of this event in units of `currency`. This should be equal to the sum of `price` times `quantity`.
     module Value
       class << self
       # List of class defined in oneOf (OpenAPI v3)
diff --git a/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/insights/Price.scala b/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/insights/Price.scala
@@ -29,7 +29,7 @@ package algoliasearch.insights
 
 import org.json4s._
 
-/** Total price of a product, including any discounts, in units of `currency`.
+/** Final price of a single product, including any discounts, in units of `currency`.
   */
 sealed trait Price
 
diff --git a/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/insights/Value.scala b/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/insights/Value.scala
@@ -29,7 +29,8 @@ package algoliasearch.insights
 
 import org.json4s._
 
-/** Total monetary value of this event in units of `currency`.
+/** Total monetary value of this event in units of `currency`. This should be equal to the sum of `price` times
+  * `quantity`.
   */
 sealed trait Value
 
diff --git a/clients/algoliasearch-client-swift/Sources/Insights/Models/InsightsValue.swift b/clients/algoliasearch-client-swift/Sources/Insights/Models/InsightsValue.swift
@@ -6,7 +6,8 @@ import Foundation
     import Core
 #endif
 
-/// Total monetary value of this event in units of `currency`.
+/// Total monetary value of this event in units of `currency`. This should be equal to the sum of `price` times
+/// `quantity`.
 public enum InsightsValue: Codable, JSONEncodable, AbstractEncodable {
     case double(Double)
     case string(String)
diff --git a/clients/algoliasearch-client-swift/Sources/Insights/Models/Price.swift b/clients/algoliasearch-client-swift/Sources/Insights/Models/Price.swift
@@ -6,7 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// Total price of a product, including any discounts, in units of `currency`.
+/// Final price of a single product, including any discounts, in units of `currency`.
 public enum Price: Codable, JSONEncodable, AbstractEncodable {
     case double(Double)
     case string(String)
diff --git a/docs/bundled/insights.json b/docs/bundled/insights.json
@@ -1076,7 +1076,7 @@
         "example": "EUR"
       },
       "price": {
-        "description": "Total price of a product, including any discounts, in units of `currency`.",
+        "description": "Final price of a single product, including any discounts, in units of `currency`.",
         "oneOf": [
           {
             "type": "number",
@@ -1142,7 +1142,7 @@
         "maxItems": 20
       },
       "value": {
-        "description": "Total monetary value of this event in units of `currency`.",
+        "description": "Total monetary value of this event in units of `currency`.\nThis should be equal to the sum of `price` times `quantity`.\n",
         "oneOf": [
           {
             "type": "number",
diff --git a/docs/bundled/insights.yml b/docs/bundled/insights.yml
@@ -2368,7 +2368,7 @@ components:
       example: EUR
     price:
       description: >-
-        Total price of a product, including any discounts, in units of
+        Final price of a single product, including any discounts, in units of
         `currency`.
       oneOf:
         - type: number
@@ -2425,7 +2425,9 @@ components:
       minItems: 1
       maxItems: 20
     value:
-      description: Total monetary value of this event in units of `currency`.
+      description: |
+        Total monetary value of this event in units of `currency`.
+        This should be equal to the sum of `price` times `quantity`.
       oneOf:
         - type: number
           format: double
diff --git a/specs/bundled/insights.yml b/specs/bundled/insights.yml
@@ -951,7 +951,7 @@ components:
       example: EUR
     price:
       description: >-
-        Total price of a product, including any discounts, in units of
+        Final price of a single product, including any discounts, in units of
         `currency`.
       oneOf:
         - type: number
@@ -1008,7 +1008,9 @@ components:
       minItems: 1
       maxItems: 20
     value:
-      description: Total monetary value of this event in units of `currency`.
+      description: |
+        Total monetary value of this event in units of `currency`.
+        This should be equal to the sum of `price` times `quantity`.
       oneOf:
         - type: number
           format: double

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ import kotlinx.serialization.json.*`
`11`	`11`	`import kotlin.jvm.JvmInline`
`12`	`12`
`13`	`13`	`/**`
`14`		- * Total price of a product, including any discounts, in units of `currency`.
	`14`	+ * Final price of a single product, including any discounts, in units of `currency`.
`15`	`15`	`*`
`16`	`16`	`* Implementations:`
`17`	`17`	`* - [Double] - [Price.of]`