Skip to content

Commit b4c0fe6

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 19bde09 commit b4c0fe6

12 files changed

Lines changed: 12 additions & 12 deletions

algoliasearch/insights/models/added_to_cart_object_ids.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ class AddedToCartObjectIDs(BaseModel):
6565
object_data: Optional[List[ObjectData]] = None
6666
""" Extra information about the records involved in a purchase or add-to-cart event. If specified, it must have the same length as `objectIDs`. """
6767
timestamp: Optional[int] = None
68-
""" Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp. """
68+
""" Timestamp of the event, measured in milliseconds since the Unix epoch. Must be no older than 30 days. If not provided, we use the time at which the request was received. """
6969
value: Optional[Value] = None
7070

7171
@field_validator("event_name")

algoliasearch/insights/models/added_to_cart_object_ids_after_search.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ class AddedToCartObjectIDsAfterSearch(BaseModel):
6868
object_data: Optional[List[ObjectDataAfterSearch]] = None
6969
""" Extra information about the records involved in a purchase or add-to-cart events. If provided, it must be the same length as `objectIDs`. """
7070
timestamp: Optional[int] = None
71-
""" Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights 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 days. If not provided, we use the time at which the request was received. """
7272
value: Optional[Value] = None
7373

7474
@field_validator("event_name")

algoliasearch/insights/models/clicked_filters.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ class ClickedFilters(BaseModel):
5353
authenticated_user_token: Optional[str] = None
5454
""" Identifier for authenticated users. When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken). """
5555
timestamp: Optional[int] = None
56-
""" Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp. """
56+
""" Timestamp of the event, measured in milliseconds since the Unix epoch. Must be no older than 30 days. If not provided, we use the time at which the request was received. """
5757

5858
@field_validator("event_name")
5959
def event_name_validate_regular_expression(cls, value):

algoliasearch/insights/models/clicked_object_ids.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ class ClickedObjectIDs(BaseModel):
5353
authenticated_user_token: Optional[str] = None
5454
""" Identifier for authenticated users. When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken). """
5555
timestamp: Optional[int] = None
56-
""" Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp. """
56+
""" Timestamp of the event, measured in milliseconds since the Unix epoch. Must be no older than 30 days. If not provided, we use the time at which the request was received. """
5757

5858
@field_validator("event_name")
5959
def event_name_validate_regular_expression(cls, value):

algoliasearch/insights/models/clicked_object_ids_after_search.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ class ClickedObjectIDsAfterSearch(BaseModel):
5959
authenticated_user_token: Optional[str] = None
6060
""" Identifier for authenticated users. When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken). """
6161
timestamp: Optional[int] = None
62-
""" Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp. """
62+
""" Timestamp of the event, measured in milliseconds since the Unix epoch. Must be no older than 30 days. If not provided, we use the time at which the request was received. """
6363

6464
@field_validator("event_name")
6565
def event_name_validate_regular_expression(cls, value):

algoliasearch/insights/models/converted_filters.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ class ConvertedFilters(BaseModel):
5353
authenticated_user_token: Optional[str] = None
5454
""" Identifier for authenticated users. When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken). """
5555
timestamp: Optional[int] = None
56-
""" Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp. """
56+
""" Timestamp of the event, measured in milliseconds since the Unix epoch. Must be no older than 30 days. If not provided, we use the time at which the request was received. """
5757

5858
@field_validator("event_name")
5959
def event_name_validate_regular_expression(cls, value):

algoliasearch/insights/models/converted_object_ids.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ class ConvertedObjectIDs(BaseModel):
5353
authenticated_user_token: Optional[str] = None
5454
""" Identifier for authenticated users. When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken). """
5555
timestamp: Optional[int] = None
56-
""" Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp. """
56+
""" Timestamp of the event, measured in milliseconds since the Unix epoch. Must be no older than 30 days. If not provided, we use the time at which the request was received. """
5757

5858
@field_validator("event_name")
5959
def event_name_validate_regular_expression(cls, value):

algoliasearch/insights/models/converted_object_ids_after_search.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ class ConvertedObjectIDsAfterSearch(BaseModel):
5656
authenticated_user_token: Optional[str] = None
5757
""" Identifier for authenticated users. When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken). """
5858
timestamp: Optional[int] = None
59-
""" Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp. """
59+
""" Timestamp of the event, measured in milliseconds since the Unix epoch. Must be no older than 30 days. If not provided, we use the time at which the request was received. """
6060

6161
@field_validator("event_name")
6262
def event_name_validate_regular_expression(cls, value):

algoliasearch/insights/models/purchased_object_ids.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ class PurchasedObjectIDs(BaseModel):
6565
object_data: Optional[List[ObjectData]] = None
6666
""" Extra information about the records involved in a purchase or add-to-cart event. If specified, it must have the same length as `objectIDs`. """
6767
timestamp: Optional[int] = None
68-
""" Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp. """
68+
""" Timestamp of the event, measured in milliseconds since the Unix epoch. Must be no older than 30 days. If not provided, we use the time at which the request was received. """
6969
value: Optional[Value] = None
7070

7171
@field_validator("event_name")

algoliasearch/insights/models/purchased_object_ids_after_search.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ class PurchasedObjectIDsAfterSearch(BaseModel):
6565
object_data: List[ObjectDataAfterSearch]
6666
""" Extra information about the records involved in a purchase or add-to-cart events. If provided, it must be the same length as `objectIDs`. """
6767
timestamp: Optional[int] = None
68-
""" Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp. """
68+
""" Timestamp of the event, measured in milliseconds since the Unix epoch. Must be no older than 30 days. If not provided, we use the time at which the request was received. """
6969
value: Optional[Value] = None
7070

7171
@field_validator("event_name")

0 commit comments

Comments
 (0)