Skip to content

Commit 1b858cd

Browse files
algolia-botsirockin
andcommitted
fix(specs): insights-api timestamp documentation (generated)
algolia/api-clients-automation#5925 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Dave Sirockin <dave@sirockin.com>
1 parent 6d6f6b6 commit 1b858cd

12 files changed

+48
-48
lines changed

client/src/commonMain/kotlin/com/algolia/client/model/insights/AddedToCartObjectIDs.kt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ import kotlinx.serialization.json.*
3333
* @param currency Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).
3434
* @param objectData Extra information about the records involved in a purchase or add-to-cart
3535
* event. If specified, it must have the same length as `objectIDs`.
36-
* @param timestamp Timestamp of the event, measured in milliseconds since the Unix epoch. By
37-
* default, the Insights API uses the time it receives an event as its timestamp.
36+
* @param timestamp Timestamp of the event, measured in milliseconds since the Unix epoch. Must be
37+
* no older than 30 days. If not provided, we use the time at which the request was received.
3838
* @param `value`
3939
*/
4040
@Serializable
@@ -82,8 +82,8 @@ public data class AddedToCartObjectIDs(
8282
@SerialName(value = "objectData") val objectData: List<ObjectData>? = null,
8383

8484
/**
85-
* Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights
86-
* API uses the time it receives an event as its timestamp.
85+
* Timestamp of the event, measured in milliseconds since the Unix epoch. Must be no older than 30
86+
* days. If not provided, we use the time at which the request was received.
8787
*/
8888
@SerialName(value = "timestamp") val timestamp: Long? = null,
8989
@SerialName(value = "value") val `value`: Value? = null,

client/src/commonMain/kotlin/com/algolia/client/model/insights/AddedToCartObjectIDsAfterSearch.kt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ import kotlinx.serialization.json.*
3434
* @param currency Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).
3535
* @param objectData Extra information about the records involved in a purchase or add-to-cart
3636
* events. If provided, it must be the same length as `objectIDs`.
37-
* @param timestamp Timestamp of the event, measured in milliseconds since the Unix epoch. By
38-
* default, the Insights API uses the time it receives an event as its timestamp.
37+
* @param timestamp Timestamp of the event, measured in milliseconds since the Unix epoch. Must be
38+
* no older than 30 days. If not provided, we use the time at which the request was received.
3939
* @param `value`
4040
*/
4141
@Serializable
@@ -90,8 +90,8 @@ public data class AddedToCartObjectIDsAfterSearch(
9090
@SerialName(value = "objectData") val objectData: List<ObjectDataAfterSearch>? = null,
9191

9292
/**
93-
* Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights
94-
* API uses the time it receives an event as its timestamp.
93+
* Timestamp of the event, measured in milliseconds since the Unix epoch. Must be no older than 30
94+
* days. If not provided, we use the time at which the request was received.
9595
*/
9696
@SerialName(value = "timestamp") val timestamp: Long? = null,
9797
@SerialName(value = "value") val `value`: Value? = null,

client/src/commonMain/kotlin/com/algolia/client/model/insights/ClickedFilters.kt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ import kotlinx.serialization.json.*
2727
* identify users across sessions. Don't use personally identifiable information in user tokens.
2828
* For more information, see
2929
* [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
30-
* @param timestamp Timestamp of the event, measured in milliseconds since the Unix epoch. By
31-
* default, the Insights API uses the time it receives an event as its timestamp.
30+
* @param timestamp Timestamp of the event, measured in milliseconds since the Unix epoch. Must be
31+
* no older than 30 days. If not provided, we use the time at which the request was received.
3232
*/
3333
@Serializable
3434
public data class ClickedFilters(
@@ -68,8 +68,8 @@ public data class ClickedFilters(
6868
@SerialName(value = "authenticatedUserToken") val authenticatedUserToken: String? = null,
6969

7070
/**
71-
* Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights
72-
* API uses the time it receives an event as its timestamp.
71+
* Timestamp of the event, measured in milliseconds since the Unix epoch. Must be no older than 30
72+
* days. If not provided, we use the time at which the request was received.
7373
*/
7474
@SerialName(value = "timestamp") val timestamp: Long? = null,
7575
) : EventsItems {}

client/src/commonMain/kotlin/com/algolia/client/model/insights/ClickedObjectIDs.kt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ import kotlinx.serialization.json.*
2828
* identify users across sessions. Don't use personally identifiable information in user tokens.
2929
* For more information, see
3030
* [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
31-
* @param timestamp Timestamp of the event, measured in milliseconds since the Unix epoch. By
32-
* default, the Insights API uses the time it receives an event as its timestamp.
31+
* @param timestamp Timestamp of the event, measured in milliseconds since the Unix epoch. Must be
32+
* no older than 30 days. If not provided, we use the time at which the request was received.
3333
*/
3434
@Serializable
3535
public data class ClickedObjectIDs(
@@ -66,8 +66,8 @@ public data class ClickedObjectIDs(
6666
@SerialName(value = "authenticatedUserToken") val authenticatedUserToken: String? = null,
6767

6868
/**
69-
* Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights
70-
* API uses the time it receives an event as its timestamp.
69+
* Timestamp of the event, measured in milliseconds since the Unix epoch. Must be no older than 30
70+
* days. If not provided, we use the time at which the request was received.
7171
*/
7272
@SerialName(value = "timestamp") val timestamp: Long? = null,
7373
) : EventsItems {}

client/src/commonMain/kotlin/com/algolia/client/model/insights/ClickedObjectIDsAfterSearch.kt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ import kotlinx.serialization.json.*
3232
* identify users across sessions. Don't use personally identifiable information in user tokens.
3333
* For more information, see
3434
* [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
35-
* @param timestamp Timestamp of the event, measured in milliseconds since the Unix epoch. By
36-
* default, the Insights API uses the time it receives an event as its timestamp.
35+
* @param timestamp Timestamp of the event, measured in milliseconds since the Unix epoch. Must be
36+
* no older than 30 days. If not provided, we use the time at which the request was received.
3737
*/
3838
@Serializable
3939
public data class ClickedObjectIDsAfterSearch(
@@ -83,8 +83,8 @@ public data class ClickedObjectIDsAfterSearch(
8383
@SerialName(value = "authenticatedUserToken") val authenticatedUserToken: String? = null,
8484

8585
/**
86-
* Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights
87-
* API uses the time it receives an event as its timestamp.
86+
* Timestamp of the event, measured in milliseconds since the Unix epoch. Must be no older than 30
87+
* days. If not provided, we use the time at which the request was received.
8888
*/
8989
@SerialName(value = "timestamp") val timestamp: Long? = null,
9090
) : EventsItems {}

client/src/commonMain/kotlin/com/algolia/client/model/insights/ConvertedFilters.kt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ import kotlinx.serialization.json.*
2727
* identify users across sessions. Don't use personally identifiable information in user tokens.
2828
* For more information, see
2929
* [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
30-
* @param timestamp Timestamp of the event, measured in milliseconds since the Unix epoch. By
31-
* default, the Insights API uses the time it receives an event as its timestamp.
30+
* @param timestamp Timestamp of the event, measured in milliseconds since the Unix epoch. Must be
31+
* no older than 30 days. If not provided, we use the time at which the request was received.
3232
*/
3333
@Serializable
3434
public data class ConvertedFilters(
@@ -68,8 +68,8 @@ public data class ConvertedFilters(
6868
@SerialName(value = "authenticatedUserToken") val authenticatedUserToken: String? = null,
6969

7070
/**
71-
* Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights
72-
* API uses the time it receives an event as its timestamp.
71+
* Timestamp of the event, measured in milliseconds since the Unix epoch. Must be no older than 30
72+
* days. If not provided, we use the time at which the request was received.
7373
*/
7474
@SerialName(value = "timestamp") val timestamp: Long? = null,
7575
) : EventsItems {}

client/src/commonMain/kotlin/com/algolia/client/model/insights/ConvertedObjectIDs.kt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ import kotlinx.serialization.json.*
2929
* identify users across sessions. Don't use personally identifiable information in user tokens.
3030
* For more information, see
3131
* [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
32-
* @param timestamp Timestamp of the event, measured in milliseconds since the Unix epoch. By
33-
* default, the Insights API uses the time it receives an event as its timestamp.
32+
* @param timestamp Timestamp of the event, measured in milliseconds since the Unix epoch. Must be
33+
* no older than 30 days. If not provided, we use the time at which the request was received.
3434
*/
3535
@Serializable
3636
public data class ConvertedObjectIDs(
@@ -67,8 +67,8 @@ public data class ConvertedObjectIDs(
6767
@SerialName(value = "authenticatedUserToken") val authenticatedUserToken: String? = null,
6868

6969
/**
70-
* Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights
71-
* API uses the time it receives an event as its timestamp.
70+
* Timestamp of the event, measured in milliseconds since the Unix epoch. Must be no older than 30
71+
* days. If not provided, we use the time at which the request was received.
7272
*/
7373
@SerialName(value = "timestamp") val timestamp: Long? = null,
7474
) : EventsItems {}

client/src/commonMain/kotlin/com/algolia/client/model/insights/ConvertedObjectIDsAfterSearch.kt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ import kotlinx.serialization.json.*
3232
* identify users across sessions. Don't use personally identifiable information in user tokens.
3333
* For more information, see
3434
* [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
35-
* @param timestamp Timestamp of the event, measured in milliseconds since the Unix epoch. By
36-
* default, the Insights API uses the time it receives an event as its timestamp.
35+
* @param timestamp Timestamp of the event, measured in milliseconds since the Unix epoch. Must be
36+
* no older than 30 days. If not provided, we use the time at which the request was received.
3737
*/
3838
@Serializable
3939
public data class ConvertedObjectIDsAfterSearch(
@@ -77,8 +77,8 @@ public data class ConvertedObjectIDsAfterSearch(
7777
@SerialName(value = "authenticatedUserToken") val authenticatedUserToken: String? = null,
7878

7979
/**
80-
* Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights
81-
* API uses the time it receives an event as its timestamp.
80+
* Timestamp of the event, measured in milliseconds since the Unix epoch. Must be no older than 30
81+
* days. If not provided, we use the time at which the request was received.
8282
*/
8383
@SerialName(value = "timestamp") val timestamp: Long? = null,
8484
) : EventsItems {}

client/src/commonMain/kotlin/com/algolia/client/model/insights/PurchasedObjectIDs.kt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ import kotlinx.serialization.json.*
3232
* @param currency Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).
3333
* @param objectData Extra information about the records involved in a purchase or add-to-cart
3434
* event. If specified, it must have the same length as `objectIDs`.
35-
* @param timestamp Timestamp of the event, measured in milliseconds since the Unix epoch. By
36-
* default, the Insights API uses the time it receives an event as its timestamp.
35+
* @param timestamp Timestamp of the event, measured in milliseconds since the Unix epoch. Must be
36+
* no older than 30 days. If not provided, we use the time at which the request was received.
3737
* @param `value`
3838
*/
3939
@Serializable
@@ -81,8 +81,8 @@ public data class PurchasedObjectIDs(
8181
@SerialName(value = "objectData") val objectData: List<ObjectData>? = null,
8282

8383
/**
84-
* Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights
85-
* API uses the time it receives an event as its timestamp.
84+
* Timestamp of the event, measured in milliseconds since the Unix epoch. Must be no older than 30
85+
* days. If not provided, we use the time at which the request was received.
8686
*/
8787
@SerialName(value = "timestamp") val timestamp: Long? = null,
8888
@SerialName(value = "value") val `value`: Value? = null,

client/src/commonMain/kotlin/com/algolia/client/model/insights/PurchasedObjectIDsAfterSearch.kt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ import kotlinx.serialization.json.*
3131
* For more information, see
3232
* [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
3333
* @param currency Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).
34-
* @param timestamp Timestamp of the event, measured in milliseconds since the Unix epoch. By
35-
* default, the Insights API uses the time it receives an event as its timestamp.
34+
* @param timestamp Timestamp of the event, measured in milliseconds since the Unix epoch. Must be
35+
* no older than 30 days. If not provided, we use the time at which the request was received.
3636
* @param `value`
3737
*/
3838
@Serializable
@@ -80,8 +80,8 @@ public data class PurchasedObjectIDsAfterSearch(
8080
@SerialName(value = "currency") val currency: String? = null,
8181

8282
/**
83-
* Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights
84-
* API uses the time it receives an event as its timestamp.
83+
* Timestamp of the event, measured in milliseconds since the Unix epoch. Must be no older than 30
84+
* days. If not provided, we use the time at which the request was received.
8585
*/
8686
@SerialName(value = "timestamp") val timestamp: Long? = null,
8787
@SerialName(value = "value") val `value`: Value? = null,

0 commit comments

Comments
 (0)