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.30"
+version = "1.0.31"
 description = "A Python library for the Trophy API"
 license = {text = "MIT"}
 readme = "README.md"

trophy/achievements/client.py

@@ -29,13 +29,16 @@ def with_raw_response(self) -> RawAchievementsClient:
         return self._raw_client
 
     def all_(
-        self, *, request_options: typing.Optional[RequestOptions] = None
+        self, *, user_attributes: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[AchievementWithStatsResponse]:
         """
         Get all achievements and their completion stats.
 
         Parameters
         ----------
+        user_attributes : typing.Optional[str]
+            Optional colon-delimited user attributes in the format attribute:value,attribute:value. Only achievements accessible to a user with the provided attributes will be returned.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -51,9 +54,11 @@ def all_(
         client = TrophyApi(
             api_key="YOUR_API_KEY",
         )
-        client.achievements.all_()
+        client.achievements.all_(
+            user_attributes="plan-type:premium,region:us-east",
+        )
         """
-        _response = self._raw_client.all_(request_options=request_options)
+        _response = self._raw_client.all_(user_attributes=user_attributes, request_options=request_options)
         return _response.data
 
     def complete(
@@ -118,13 +123,16 @@ def with_raw_response(self) -> AsyncRawAchievementsClient:
         return self._raw_client
 
     async def all_(
-        self, *, request_options: typing.Optional[RequestOptions] = None
+        self, *, user_attributes: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[AchievementWithStatsResponse]:
         """
         Get all achievements and their completion stats.
 
         Parameters
         ----------
+        user_attributes : typing.Optional[str]
+            Optional colon-delimited user attributes in the format attribute:value,attribute:value. Only achievements accessible to a user with the provided attributes will be returned.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -145,12 +153,14 @@ async def all_(
 
 
         async def main() -> None:
-            await client.achievements.all_()
+            await client.achievements.all_(
+                user_attributes="plan-type:premium,region:us-east",
+            )
 
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.all_(request_options=request_options)
+        _response = await self._raw_client.all_(user_attributes=user_attributes, request_options=request_options)
         return _response.data
 
     async def complete(

trophy/achievements/raw_client.py

@@ -27,13 +27,16 @@ def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._client_wrapper = client_wrapper
 
     def all_(
-        self, *, request_options: typing.Optional[RequestOptions] = None
+        self, *, user_attributes: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> HttpResponse[typing.List[AchievementWithStatsResponse]]:
         """
         Get all achievements and their completion stats.
 
         Parameters
         ----------
+        user_attributes : typing.Optional[str]
+            Optional colon-delimited user attributes in the format attribute:value,attribute:value. Only achievements accessible to a user with the provided attributes will be returned.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -46,6 +49,9 @@ def all_(
             "achievements",
             base_url=self._client_wrapper.get_environment().api,
             method="GET",
+            params={
+                "userAttributes": user_attributes,
+            },
             request_options=request_options,
         )
         try:
@@ -176,13 +182,16 @@ def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._client_wrapper = client_wrapper
 
     async def all_(
-        self, *, request_options: typing.Optional[RequestOptions] = None
+        self, *, user_attributes: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[typing.List[AchievementWithStatsResponse]]:
         """
         Get all achievements and their completion stats.
 
         Parameters
         ----------
+        user_attributes : typing.Optional[str]
+            Optional colon-delimited user attributes in the format attribute:value,attribute:value. Only achievements accessible to a user with the provided attributes will be returned.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -195,6 +204,9 @@ async def all_(
             "achievements",
             base_url=self._client_wrapper.get_environment().api,
             method="GET",
+            params={
+                "userAttributes": user_attributes,
+            },
             request_options=request_options,
         )
         try:

trophy/leaderboards/client.py

@@ -60,6 +60,7 @@ def get(
         limit: typing.Optional[int] = None,
         run: typing.Optional[str] = None,
         user_id: typing.Optional[str] = None,
+        user_attributes: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> LeaderboardResponseWithRankings:
         """
@@ -82,6 +83,9 @@ def get(
         user_id : typing.Optional[str]
             When provided, offset is relative to this user's position on the leaderboard. If the user is not found in the leaderboard, returns empty rankings array.
 
+        user_attributes : typing.Optional[str]
+            Attribute key and value to filter the rankings by, separated by a colon. This parameter is required, and only valid for leaderboards with a breakdown attribute.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -103,10 +107,17 @@ def get(
             limit=1,
             run="2025-01-15",
             user_id="user-123",
+            user_attributes="city:London",
         )
         """
         _response = self._raw_client.get(
-            key, offset=offset, limit=limit, run=run, user_id=user_id, request_options=request_options
+            key,
+            offset=offset,
+            limit=limit,
+            run=run,
+            user_id=user_id,
+            user_attributes=user_attributes,
+            request_options=request_options,
         )
         return _response.data
 
@@ -170,6 +181,7 @@ async def get(
         limit: typing.Optional[int] = None,
         run: typing.Optional[str] = None,
         user_id: typing.Optional[str] = None,
+        user_attributes: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> LeaderboardResponseWithRankings:
         """
@@ -192,6 +204,9 @@ async def get(
         user_id : typing.Optional[str]
             When provided, offset is relative to this user's position on the leaderboard. If the user is not found in the leaderboard, returns empty rankings array.
 
+        user_attributes : typing.Optional[str]
+            Attribute key and value to filter the rankings by, separated by a colon. This parameter is required, and only valid for leaderboards with a breakdown attribute.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -218,12 +233,19 @@ async def main() -> None:
                 limit=1,
                 run="2025-01-15",
                 user_id="user-123",
+                user_attributes="city:London",
             )
 
 
         asyncio.run(main())
         """
         _response = await self._raw_client.get(
-            key, offset=offset, limit=limit, run=run, user_id=user_id, request_options=request_options
+            key,
+            offset=offset,
+            limit=limit,
+            run=run,
+            user_id=user_id,
+            user_attributes=user_attributes,
+            request_options=request_options,
         )
         return _response.data

trophy/leaderboards/raw_client.py

@@ -88,6 +88,7 @@ def get(
         limit: typing.Optional[int] = None,
         run: typing.Optional[str] = None,
         user_id: typing.Optional[str] = None,
+        user_attributes: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[LeaderboardResponseWithRankings]:
         """
@@ -110,6 +111,9 @@ def get(
         user_id : typing.Optional[str]
             When provided, offset is relative to this user's position on the leaderboard. If the user is not found in the leaderboard, returns empty rankings array.
 
+        user_attributes : typing.Optional[str]
+            Attribute key and value to filter the rankings by, separated by a colon. This parameter is required, and only valid for leaderboards with a breakdown attribute.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -127,6 +131,7 @@ def get(
                 "limit": limit,
                 "run": run,
                 "userId": user_id,
+                "userAttributes": user_attributes,
             },
             request_options=request_options,
         )
@@ -250,6 +255,7 @@ async def get(
         limit: typing.Optional[int] = None,
         run: typing.Optional[str] = None,
         user_id: typing.Optional[str] = None,
+        user_attributes: typing.Optional[str] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[LeaderboardResponseWithRankings]:
         """
@@ -272,6 +278,9 @@ async def get(
         user_id : typing.Optional[str]
             When provided, offset is relative to this user's position on the leaderboard. If the user is not found in the leaderboard, returns empty rankings array.
 
+        user_attributes : typing.Optional[str]
+            Attribute key and value to filter the rankings by, separated by a colon. This parameter is required, and only valid for leaderboards with a breakdown attribute.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -289,6 +298,7 @@ async def get(
                 "limit": limit,
                 "run": run,
                 "userId": user_id,
+                "userAttributes": user_attributes,
             },
             request_options=request_options,
         )

trophy/points/client.py

@@ -40,7 +40,7 @@ def summary(
             Key of the points system.
 
         user_attributes : typing.Optional[str]
-            Optional colon-delimited user attribute filters in the format attributeKey:value,attributeKey:value. Only users matching ALL specified attributes will be included in the points breakdown.
+            Optional colon-delimited user attribute filters in the format attribute:value,attribute:value. Only users matching ALL specified attributes will be included in the points breakdown.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -128,7 +128,7 @@ async def summary(
             Key of the points system.
 
         user_attributes : typing.Optional[str]
-            Optional colon-delimited user attribute filters in the format attributeKey:value,attributeKey:value. Only users matching ALL specified attributes will be included in the points breakdown.
+            Optional colon-delimited user attribute filters in the format attribute:value,attribute:value. Only users matching ALL specified attributes will be included in the points breakdown.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.

trophy/points/raw_client.py

@@ -37,7 +37,7 @@ def summary(
             Key of the points system.
 
         user_attributes : typing.Optional[str]
-            Optional colon-delimited user attribute filters in the format attributeKey:value,attributeKey:value. Only users matching ALL specified attributes will be included in the points breakdown.
+            Optional colon-delimited user attribute filters in the format attribute:value,attribute:value. Only users matching ALL specified attributes will be included in the points breakdown.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -187,7 +187,7 @@ async def summary(
             Key of the points system.
 
         user_attributes : typing.Optional[str]
-            Optional colon-delimited user attribute filters in the format attributeKey:value,attributeKey:value. Only users matching ALL specified attributes will be included in the points breakdown.
+            Optional colon-delimited user attribute filters in the format attribute:value,attribute:value. Only users matching ALL specified attributes will be included in the points breakdown.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.

trophy/types/leaderboard_response.py

@@ -35,6 +35,13 @@ class LeaderboardResponse(UniversalBaseModel):
     What the leaderboard ranks by.
     """
 
+    breakdown_attribute: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="breakdownAttribute")
+    ] = pydantic.Field(default=None)
+    """
+    The key of the attribute to break down this leaderboard by.
+    """
+
     metric_key: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="metricKey")] = pydantic.Field(
         default=None
     )

trophy/types/metric_event_leaderboard_response.py

@@ -33,6 +33,13 @@ class MetricEventLeaderboardResponse(UniversalBaseModel):
     The minimum value required to enter the leaderboard according to its current rankings.
     """
 
+    breakdown_attribute_value: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="breakdownAttributeValue")
+    ] = pydantic.Field(default=None)
+    """
+    For leaderboards with a breakdown attribute, the value of the attribute for the user.
+    """
+
     id: str = pydantic.Field()
     """
     The unique ID of the leaderboard.
@@ -53,6 +60,13 @@ class MetricEventLeaderboardResponse(UniversalBaseModel):
     What the leaderboard ranks by.
     """
 
+    breakdown_attribute: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="breakdownAttribute")
+    ] = pydantic.Field(default=None)
+    """
+    The key of the attribute to break down this leaderboard by.
+    """
+
     metric_key: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="metricKey")] = pydantic.Field(
         default=None
     )