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

trophy/achievements/client.py

@@ -94,11 +94,7 @@ def complete(
             key="finish-onboarding",
             user=UpsertedUser(
                 email="user@example.com",
-                name="User",
                 tz="Europe/London",
-                device_tokens=["token1", "token2"],
-                subscribe_to_emails=True,
-                attributes={"department": "engineering", "role": "developer"},
                 id="user-id",
             ),
         )
@@ -201,11 +197,7 @@ async def main() -> None:
                 key="finish-onboarding",
                 user=UpsertedUser(
                     email="user@example.com",
-                    name="User",
                     tz="Europe/London",
-                    device_tokens=["token1", "token2"],
-                    subscribe_to_emails=True,
-                    attributes={"department": "engineering", "role": "developer"},
                     id="user-id",
                 ),
             )

trophy/leaderboards/client.py

@@ -75,7 +75,7 @@ def get(
             Number of rankings to skip for pagination.
 
         limit : typing.Optional[int]
-            Maximum number of rankings to return.
+            Maximum number of rankings to return. Cannot be greater than the size of the leaderboard.
 
         run : typing.Optional[str]
             Specific run date in YYYY-MM-DD format. If not provided, returns the current run.
@@ -84,7 +84,7 @@ def get(
             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.
+            Attribute key and value to filter the rankings by, separated by a colon. For example, `city:London`. This parameter is required, and only valid for leaderboards with a breakdown attribute.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -196,7 +196,7 @@ async def get(
             Number of rankings to skip for pagination.
 
         limit : typing.Optional[int]
-            Maximum number of rankings to return.
+            Maximum number of rankings to return. Cannot be greater than the size of the leaderboard.
 
         run : typing.Optional[str]
             Specific run date in YYYY-MM-DD format. If not provided, returns the current run.
@@ -205,7 +205,7 @@ async def get(
             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.
+            Attribute key and value to filter the rankings by, separated by a colon. For example, `city:London`. This parameter is required, and only valid for leaderboards with a breakdown attribute.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.

trophy/leaderboards/raw_client.py

@@ -103,7 +103,7 @@ def get(
             Number of rankings to skip for pagination.
 
         limit : typing.Optional[int]
-            Maximum number of rankings to return.
+            Maximum number of rankings to return. Cannot be greater than the size of the leaderboard.
 
         run : typing.Optional[str]
             Specific run date in YYYY-MM-DD format. If not provided, returns the current run.
@@ -112,7 +112,7 @@ def get(
             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.
+            Attribute key and value to filter the rankings by, separated by a colon. For example, `city:London`. This parameter is required, and only valid for leaderboards with a breakdown attribute.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -270,7 +270,7 @@ async def get(
             Number of rankings to skip for pagination.
 
         limit : typing.Optional[int]
-            Maximum number of rankings to return.
+            Maximum number of rankings to return. Cannot be greater than the size of the leaderboard.
 
         run : typing.Optional[str]
             Specific run date in YYYY-MM-DD format. If not provided, returns the current run.
@@ -279,7 +279,7 @@ async def get(
             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.
+            Attribute key and value to filter the rankings by, separated by a colon. For example, `city:London`. This parameter is required, and only valid for leaderboards with a breakdown attribute.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.

trophy/metrics/client.py

@@ -77,10 +77,7 @@ def event(
             idempotency_key="e4296e4b-8493-4bd1-9c30-5a1a9ac4d78f",
             user=UpsertedUser(
                 email="user@example.com",
-                name="User",
                 tz="Europe/London",
-                device_tokens=["token1", "token2"],
-                subscribe_to_emails=True,
                 attributes={"department": "engineering", "role": "developer"},
                 id="18",
             ),
@@ -169,10 +166,7 @@ async def main() -> None:
                 idempotency_key="e4296e4b-8493-4bd1-9c30-5a1a9ac4d78f",
                 user=UpsertedUser(
                     email="user@example.com",
-                    name="User",
                     tz="Europe/London",
-                    device_tokens=["token1", "token2"],
-                    subscribe_to_emails=True,
                     attributes={"department": "engineering", "role": "developer"},
                     id="18",
                 ),

trophy/types/updated_user.py

@@ -13,12 +13,12 @@ class UpdatedUser(UniversalBaseModel):
     An object with editable user fields.
     """
 
-    email: str = pydantic.Field()
+    email: typing.Optional[str] = pydantic.Field(default=None)
     """
     The user's email address. Required if subscribeToEmails is true.
     """
 
-    name: str = pydantic.Field()
+    name: typing.Optional[str] = pydantic.Field(default=None)
     """
     The name to refer to the user by in emails.
     """
@@ -28,17 +28,21 @@ class UpdatedUser(UniversalBaseModel):
     The user's timezone (used for email scheduling).
     """
 
-    device_tokens: typing_extensions.Annotated[typing.List[str], FieldMetadata(alias="deviceTokens")] = pydantic.Field()
+    device_tokens: typing_extensions.Annotated[
+        typing.Optional[typing.List[str]], FieldMetadata(alias="deviceTokens")
+    ] = pydantic.Field(default=None)
     """
     The user's device tokens, used for push notifications.
     """
 
-    subscribe_to_emails: typing_extensions.Annotated[bool, FieldMetadata(alias="subscribeToEmails")] = pydantic.Field()
+    subscribe_to_emails: typing_extensions.Annotated[
+        typing.Optional[bool], FieldMetadata(alias="subscribeToEmails")
+    ] = pydantic.Field(default=None)
     """
     Whether the user should receive Trophy-powered emails. If false, Trophy will not store the user's email address.
     """
 
-    attributes: typing.Dict[str, str] = pydantic.Field()
+    attributes: typing.Optional[typing.Dict[str, str]] = pydantic.Field(default=None)
     """
     User attributes as key-value pairs. Keys must match existing user attributes set up in the Trophy dashboard.
     """

trophy/types/user.py

@@ -4,15 +4,51 @@
 import typing
 
 import pydantic
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-from .upserted_user import UpsertedUser
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
 
 
-class User(UpsertedUser):
+class User(UniversalBaseModel):
     """
     A user of your application.
     """
 
+    id: str = pydantic.Field()
+    """
+    The ID of the user in your database. Must be a string.
+    """
+
+    email: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The user's email address.
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The name of the user.
+    """
+
+    tz: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The user's timezone.
+    """
+
+    device_tokens: typing_extensions.Annotated[typing.List[str], FieldMetadata(alias="deviceTokens")] = pydantic.Field()
+    """
+    The user's device tokens.
+    """
+
+    subscribe_to_emails: typing_extensions.Annotated[bool, FieldMetadata(alias="subscribeToEmails")] = pydantic.Field()
+    """
+    Whether the user is opted into receiving Trophy-powered emails.
+    """
+
+    attributes: typing.Dict[str, str] = pydantic.Field()
+    """
+    User attributes as key-value pairs. Keys must match existing user attributes set up in the Trophy dashboard.
+    """
+
     control: bool = pydantic.Field()
     """
     Whether the user is in the control group, meaning they do not receive emails or other communications from Trophy.