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

trophy/__init__.py

@@ -2,12 +2,13 @@
 
 from .types import (
     AchievementCompletionResponse,
-    AchievementResponse,
     ErrorBody,
     EventResponse,
     EventResponseMetricsItem,
     MetricResponse,
     MetricStatus,
+    MultiStageAchievementResponse,
+    OneOffAchievementResponse,
     StreakFrequency,
     StreakResponse,
     UpdatedUser,
@@ -26,15 +27,16 @@
 
 __all__ = [
     "AchievementCompletionResponse",
-    "AchievementResponse",
     "AsyncTrophyApi",
     "BadRequestError",
     "ErrorBody",
     "EventResponse",
     "EventResponseMetricsItem",
     "MetricResponse",
     "MetricStatus",
+    "MultiStageAchievementResponse",
     "NotFoundError",
+    "OneOffAchievementResponse",
     "StreakFrequency",
     "StreakResponse",
     "TrophyApi",

trophy/types/__init__.py

@@ -1,12 +1,13 @@
 # This file was auto-generated by Fern from our API Definition.
 
 from .achievement_completion_response import AchievementCompletionResponse
-from .achievement_response import AchievementResponse
 from .error_body import ErrorBody
 from .event_response import EventResponse
 from .event_response_metrics_item import EventResponseMetricsItem
 from .metric_response import MetricResponse
 from .metric_status import MetricStatus
+from .multi_stage_achievement_response import MultiStageAchievementResponse
+from .one_off_achievement_response import OneOffAchievementResponse
 from .streak_frequency import StreakFrequency
 from .streak_response import StreakResponse
 from .updated_user import UpdatedUser
@@ -15,12 +16,13 @@
 
 __all__ = [
     "AchievementCompletionResponse",
-    "AchievementResponse",
     "ErrorBody",
     "EventResponse",
     "EventResponseMetricsItem",
     "MetricResponse",
     "MetricStatus",
+    "MultiStageAchievementResponse",
+    "OneOffAchievementResponse",
     "StreakFrequency",
     "StreakResponse",
     "UpdatedUser",

trophy/types/achievement_completion_response.py

@@ -4,7 +4,7 @@
 import typing_extensions
 from ..core.serialization import FieldMetadata
 import pydantic
-from .achievement_response import AchievementResponse
+from .one_off_achievement_response import OneOffAchievementResponse
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 import typing
 
@@ -17,7 +17,7 @@ class AchievementCompletionResponse(UniversalBaseModel):
     The unique ID of the completion.
     """
 
-    achievement: AchievementResponse
+    achievement: OneOffAchievementResponse
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(

trophy/types/event_response_metrics_item.py

@@ -5,7 +5,7 @@
 import typing
 from ..core.serialization import FieldMetadata
 import pydantic
-from .achievement_response import AchievementResponse
+from .multi_stage_achievement_response import MultiStageAchievementResponse
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
@@ -17,8 +17,8 @@ class EventResponseMetricsItem(UniversalBaseModel):
     The ID of the metric.
     """
 
-    completed: typing.Optional[typing.List[AchievementResponse]] = pydantic.Field(
-        default=None
+    completed: typing.Optional[typing.List[MultiStageAchievementResponse]] = (
+        pydantic.Field(default=None)
     )
     """
     A list of any new achievements that the user has now completed as a result of this event being submitted.

trophy/types/metric_response.py

@@ -7,7 +7,7 @@
 from ..core.serialization import FieldMetadata
 from .metric_status import MetricStatus
 import typing
-from .achievement_response import AchievementResponse
+from .multi_stage_achievement_response import MultiStageAchievementResponse
 from .streak_response import StreakResponse
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
@@ -50,7 +50,7 @@ class MetricResponse(UniversalBaseModel):
     The user's current total for the metric.
     """
 
-    achievements: typing.List[AchievementResponse] = pydantic.Field()
+    achievements: typing.List[MultiStageAchievementResponse] = pydantic.Field()
     """
     A list of the metric's achievements and the user's progress towards each.
     """

trophy/types/achievement_response.py …ypes/multi_stage_achievement_response.pytrophy/types/achievement_response.py renamed to trophy/types/multi_stage_achievement_response.py trophy/types/achievement_response.py renamed to trophy/types/multi_stage_achievement_response.py

@@ -9,7 +9,7 @@
 from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class AchievementResponse(UniversalBaseModel):
+class MultiStageAchievementResponse(UniversalBaseModel):
     id: str = pydantic.Field()
     """
     The unique ID of the achievement.

trophy/types/one_off_achievement_response.py

@@ -0,0 +1,51 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.pydantic_utilities import UniversalBaseModel
+import pydantic
+import typing
+import typing_extensions
+from ..core.serialization import FieldMetadata
+import datetime as dt
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class OneOffAchievementResponse(UniversalBaseModel):
+    id: str = pydantic.Field()
+    """
+    The unique ID of the achievement.
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The name of this achievement.
+    """
+
+    badge_url: typing_extensions.Annotated[
+        typing.Optional[str], FieldMetadata(alias="badgeUrl")
+    ] = pydantic.Field(default=None)
+    """
+    The URL of the badge image for the achievement, if one has been uploaded.
+    """
+
+    key: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The key used to reference this achievement in the API.
+    """
+
+    achieved_at: typing_extensions.Annotated[
+        typing.Optional[dt.datetime], FieldMetadata(alias="achievedAt")
+    ] = pydantic.Field(default=None)
+    """
+    The date and time the achievement was completed, in ISO 8601 format.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
+            extra="allow", frozen=True
+        )  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

trophy/users/client.py

@@ -14,7 +14,7 @@
 from ..core.jsonable_encoder import jsonable_encoder
 from ..types.metric_response import MetricResponse
 from ..errors.not_found_error import NotFoundError
-from ..types.achievement_response import AchievementResponse
+from ..types.multi_stage_achievement_response import MultiStageAchievementResponse
 from ..core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
@@ -36,7 +36,7 @@ def create(
         request_options: typing.Optional[RequestOptions] = None,
     ) -> User:
         """
-        Create a new user.
+        Identify a new user.
 
         Parameters
         ----------
@@ -61,7 +61,7 @@ def create(
         Returns
         -------
         User
-            Created user
+            Identified user
 
         Examples
         --------
@@ -485,7 +485,7 @@ def singlemetric(
 
     def allachievements(
         self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> typing.List[AchievementResponse]:
+    ) -> typing.List[MultiStageAchievementResponse]:
         """
         Get all of a user's completed achievements.
 
@@ -499,7 +499,7 @@ def allachievements(
 
         Returns
         -------
-        typing.List[AchievementResponse]
+        typing.List[MultiStageAchievementResponse]
             Successful operation
 
         Examples
@@ -521,9 +521,9 @@ def allachievements(
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    typing.List[AchievementResponse],
+                    typing.List[MultiStageAchievementResponse],
                     parse_obj_as(
-                        type_=typing.List[AchievementResponse],  # type: ignore
+                        type_=typing.List[MultiStageAchievementResponse],  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -578,7 +578,7 @@ async def create(
         request_options: typing.Optional[RequestOptions] = None,
     ) -> User:
         """
-        Create a new user.
+        Identify a new user.
 
         Parameters
         ----------
@@ -603,7 +603,7 @@ async def create(
         Returns
         -------
         User
-            Created user
+            Identified user
 
         Examples
         --------
@@ -1067,7 +1067,7 @@ async def main() -> None:
 
     async def allachievements(
         self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> typing.List[AchievementResponse]:
+    ) -> typing.List[MultiStageAchievementResponse]:
         """
         Get all of a user's completed achievements.
 
@@ -1081,7 +1081,7 @@ async def allachievements(
 
         Returns
         -------
-        typing.List[AchievementResponse]
+        typing.List[MultiStageAchievementResponse]
             Successful operation
 
         Examples
@@ -1111,9 +1111,9 @@ async def main() -> None:
         try:
             if 200 <= _response.status_code < 300:
                 return typing.cast(
-                    typing.List[AchievementResponse],
+                    typing.List[MultiStageAchievementResponse],
                     parse_obj_as(
-                        type_=typing.List[AchievementResponse],  # type: ignore
+                        type_=typing.List[MultiStageAchievementResponse],  # type: ignore
                         object_=_response.json(),
                     ),
                 )