Automatically update Python SDK

Author: github-actions[bot]

pyproject.toml

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

trophy/types/leaderboard_response.py

@@ -70,7 +70,7 @@ class LeaderboardResponse(UniversalBaseModel):
     The name of the points system to rank by, if rankBy is 'points'.
     """
 
-    description: str = pydantic.Field()
+    description: typing.Optional[str] = pydantic.Field(default=None)
     """
     The user-facing description of the leaderboard.
     """
@@ -97,9 +97,11 @@ class LeaderboardResponse(UniversalBaseModel):
     The repetition type for recurring leaderboards, or null for one-time leaderboards.
     """
 
-    run_interval: typing_extensions.Annotated[int, FieldMetadata(alias="runInterval")] = pydantic.Field()
+    run_interval: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="runInterval")] = (
+        pydantic.Field(default=None)
+    )
     """
-    The interval between repetitions, relative to the start date and repetition type.
+    The interval between repetitions, relative to the start date and repetition type. Null for one-time leaderboards.
     """
 
     if IS_PYDANTIC_V2:

trophy/types/metric_event_leaderboard_response.py

@@ -95,7 +95,7 @@ class MetricEventLeaderboardResponse(UniversalBaseModel):
     The name of the points system to rank by, if rankBy is 'points'.
     """
 
-    description: str = pydantic.Field()
+    description: typing.Optional[str] = pydantic.Field(default=None)
     """
     The user-facing description of the leaderboard.
     """
@@ -117,9 +117,11 @@ class MetricEventLeaderboardResponse(UniversalBaseModel):
     The repetition type for recurring leaderboards, or null for one-time leaderboards.
     """
 
-    run_interval: typing_extensions.Annotated[int, FieldMetadata(alias="runInterval")] = pydantic.Field()
+    run_interval: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="runInterval")] = (
+        pydantic.Field(default=None)
+    )
     """
-    The interval between repetitions, relative to the start date and repetition type.
+    The interval between repetitions, relative to the start date and repetition type. Null for one-time leaderboards.
     """
 
     if IS_PYDANTIC_V2:

trophy/users/client.py

@@ -600,6 +600,7 @@ def leaderboard(
         key: str,
         *,
         run: typing.Optional[str] = None,
+        num_events: typing.Optional[int] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> UserLeaderboardResponseWithHistory:
         """
@@ -616,6 +617,9 @@ def leaderboard(
         run : typing.Optional[str]
             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.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -635,9 +639,12 @@ def leaderboard(
             id="user-123",
             key="weekly-words",
             run="2025-01-15",
+            num_events=1,
         )
         """
-        _response = self._raw_client.leaderboard(id, key, run=run, request_options=request_options)
+        _response = self._raw_client.leaderboard(
+            id, key, run=run, num_events=num_events, request_options=request_options
+        )
         return _response.data
 
 
@@ -1309,6 +1316,7 @@ async def leaderboard(
         key: str,
         *,
         run: typing.Optional[str] = None,
+        num_events: typing.Optional[int] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> UserLeaderboardResponseWithHistory:
         """
@@ -1325,6 +1333,9 @@ async def leaderboard(
         run : typing.Optional[str]
             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.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -1349,10 +1360,13 @@ async def main() -> None:
                 id="user-123",
                 key="weekly-words",
                 run="2025-01-15",
+                num_events=1,
             )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.leaderboard(id, key, run=run, request_options=request_options)
+        _response = await self._raw_client.leaderboard(
+            id, key, run=run, num_events=num_events, request_options=request_options
+        )
         return _response.data

trophy/users/raw_client.py

@@ -1054,6 +1054,7 @@ def leaderboard(
         key: str,
         *,
         run: typing.Optional[str] = None,
+        num_events: typing.Optional[int] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[UserLeaderboardResponseWithHistory]:
         """
@@ -1070,6 +1071,9 @@ def leaderboard(
         run : typing.Optional[str]
             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.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -1084,6 +1088,7 @@ def leaderboard(
             method="GET",
             params={
                 "run": run,
+                "numEvents": num_events,
             },
             request_options=request_options,
         )
@@ -2161,6 +2166,7 @@ async def leaderboard(
         key: str,
         *,
         run: typing.Optional[str] = None,
+        num_events: typing.Optional[int] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[UserLeaderboardResponseWithHistory]:
         """
@@ -2177,6 +2183,9 @@ async def leaderboard(
         run : typing.Optional[str]
             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.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -2191,6 +2200,7 @@ async def leaderboard(
             method="GET",
             params={
                 "run": run,
+                "numEvents": num_events,
             },
             request_options=request_options,
         )