Automatically update Python SDK

Author: github-actions[bot]

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "trophy"
-version = "1.10.0"
+version = "1.11.0"
 description = "A Python library for the Trophy API"
 license = {text = "MIT"}
 readme = "README.md"

trophy/types/leaderboard_event.py

@@ -11,12 +11,17 @@
 
 class LeaderboardEvent(UniversalBaseModel):
     """
-    A leaderboard event representing a change in a user's rank or value.
+    A daily leaderboard snapshot entry representing the user's rank/value state and the previous persisted state.
     """
 
-    timestamp: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    date: str = pydantic.Field()
     """
-    The timestamp when the event occurred.
+    The leaderboard snapshot date in YYYY-MM-DD format.
+    """
+
+    timestamp: dt.datetime = pydantic.Field()
+    """
+    Deprecated ISO timestamp for the snapshot day boundary. Use `date` instead.
     """
 
     previous_rank: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="previousRank")] = (

trophy/types/user_leaderboard_response_with_history.py

@@ -15,7 +15,7 @@ class UserLeaderboardResponseWithHistory(UserLeaderboardResponse):
 
     history: typing.List[LeaderboardEvent] = pydantic.Field()
     """
-    An array of events showing the user's rank and value changes over time.
+    An array of daily change events showing the user's rank and value over time.
     """
 
     if IS_PYDANTIC_V2:

trophy/users/client.py

@@ -736,7 +736,7 @@ def leaderboard(
         request_options: typing.Optional[RequestOptions] = None,
     ) -> UserLeaderboardResponseWithHistory:
         """
-        Get a user's rank, value, and history for a specific leaderboard.
+        Get a user's rank, value, and daily ranking history for a specific leaderboard.
 
         Parameters
         ----------
@@ -750,7 +750,7 @@ def leaderboard(
             Specific run date in YYYY-MM-DD format. If not provided, returns the current run.
 
         num_events : typing.Optional[int]
-            The number of events to return in the history array.
+            The number of days to return in the leaderboard history for the user.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -1643,7 +1643,7 @@ async def leaderboard(
         request_options: typing.Optional[RequestOptions] = None,
     ) -> UserLeaderboardResponseWithHistory:
         """
-        Get a user's rank, value, and history for a specific leaderboard.
+        Get a user's rank, value, and daily ranking history for a specific leaderboard.
 
         Parameters
         ----------
@@ -1657,7 +1657,7 @@ async def leaderboard(
             Specific run date in YYYY-MM-DD format. If not provided, returns the current run.
 
         num_events : typing.Optional[int]
-            The number of events to return in the history array.
+            The number of days to return in the leaderboard history for the user.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.

trophy/users/raw_client.py

@@ -1300,7 +1300,7 @@ def leaderboard(
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[UserLeaderboardResponseWithHistory]:
         """
-        Get a user's rank, value, and history for a specific leaderboard.
+        Get a user's rank, value, and daily ranking history for a specific leaderboard.
 
         Parameters
         ----------
@@ -1314,7 +1314,7 @@ def leaderboard(
             Specific run date in YYYY-MM-DD format. If not provided, returns the current run.
 
         num_events : typing.Optional[int]
-            The number of events to return in the history array.
+            The number of days to return in the leaderboard history for the user.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -2728,7 +2728,7 @@ async def leaderboard(
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[UserLeaderboardResponseWithHistory]:
         """
-        Get a user's rank, value, and history for a specific leaderboard.
+        Get a user's rank, value, and daily ranking history for a specific leaderboard.
 
         Parameters
         ----------
@@ -2742,7 +2742,7 @@ async def leaderboard(
             Specific run date in YYYY-MM-DD format. If not provided, returns the current run.
 
         num_events : typing.Optional[int]
-            The number of events to return in the history array.
+            The number of days to return in the leaderboard history for the user.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.