f3-data-models 0.5.15__tar.gz → 0.5.17__tar.gz

{f3_data_models-0.5.15 → f3_data_models-0.5.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: f3-data-models
-Version: 0.5.15
+Version: 0.5.17
 Summary: The data schema and models for F3 Nation applications.
 License: MIT
 Author: Evan Petzoldt

{f3_data_models-0.5.15 → f3_data_models-0.5.17}/f3_data_models/models.py

@@ -136,6 +136,38 @@ class Event_Cadence(enum.Enum):
     monthly = 2
 
 
+class Achievement_Cadence(enum.Enum):
+    """
+    Enum representing the cadence of an achievement.
+
+    Attributes:
+        weekly
+        monthly
+        quarterly
+        yearly
+        lifetime
+    """
+
+    weekly = 1
+    monthly = 2
+    quarterly = 3
+    yearly = 4
+    lifetime = 5
+
+
+class Achievement_Threshold_Type(enum.Enum):
+    """
+    Enum representing the type of threshold for an achievement.
+
+    Attributes:
+        posts
+        unique_aos
+    """
+
+    posts = 1
+    unique_aos = 2
+
+
 class Org_Type(enum.Enum):
     """
     Enum representing the type of organization.
@@ -957,7 +989,7 @@ class SlackUser(Base):
         strava_expires_at (Optional[datetime]): The expiration time of the Strava token.
         strava_athlete_id (Optional[int]): The Strava athlete ID of the user.
         meta (Optional[Dict[str, Any]]): Additional metadata for the Slack user.
-        slack_updated (Optional[datetime]): The last update time of the Slack user.
+        slack_updated (Optional[int]): The last update time of the Slack user.
         created (datetime): The timestamp when the record was created.
         updated (datetime): The timestamp when the record was last updated.
     """  # noqa: E501
@@ -979,7 +1011,7 @@ class SlackUser(Base):
     strava_expires_at: Mapped[Optional[datetime]]
     strava_athlete_id: Mapped[Optional[int]]
     meta: Mapped[Optional[Dict[str, Any]]]
-    slack_updated: Mapped[Optional[datetime]]
+    slack_updated: Mapped[Optional[int]]
     created: Mapped[dt_create]
     updated: Mapped[dt_update]
 
@@ -1044,9 +1076,14 @@ class Achievement(Base):
         id (int): Primary Key of the model.
         name (str): The name of the achievement.
         description (Optional[str]): A description of the achievement.
-        verb (str): The verb associated with the achievement.
         image_url (Optional[str]): The URL of the achievement's image.
         specific_org_id (Optional[int]): The ID of the specific region if a custom achievement. If null, the achievement is available to all regions.
+        is_active (bool): Whether the achievement is active. Default is True.
+        auto_award (bool): Whether the achievement is automatically awarded or needs to be manually tagged. Default is False.
+        auto_cadence (Optional[Achievement_Cadence]): The cadence for automatic awarding of the achievement.
+        auto_threshold (Optional[int]): The threshold for automatic awarding of the achievement.
+        auto_threshold_type (Optional[Achievement_Threshold_Type]): The type of threshold for automatic awarding of the achievement ('posts', 'unique_aos', etc.).
+        auto_filters (Optional[Dict[str, Any]]): Event filters for automatic awarding of the achievement. Should be a format like {'include': [{'event_type_id': [1, 2]}, {'event_tag_id': [3]}], 'exclude': [{'event_category': ['third_f']}]}.
         created (datetime): The timestamp when the record was created.
         updated (datetime): The timestamp when the record was last updated.
     """  # noqa: E501
@@ -1056,9 +1093,15 @@ class Achievement(Base):
     id: Mapped[intpk]
     name: Mapped[str]
     description: Mapped[Optional[str]]
-    verb: Mapped[str]
     image_url: Mapped[Optional[str]]
     specific_org_id: Mapped[Optional[int]] = mapped_column(ForeignKey("orgs.id"))
+    is_active: Mapped[bool] = mapped_column(Boolean, server_default="true", nullable=False)
+    auto_award: Mapped[bool] = mapped_column(Boolean, server_default="false", nullable=False)
+    auto_cadence: Mapped[Optional[Achievement_Cadence]]
+    auto_threshold_type: Mapped[Optional[Achievement_Threshold_Type]]
+    auto_threshold: Mapped[Optional[int]]
+    auto_filters: Mapped[Optional[Dict[str, Any]]] = mapped_column(JSON, default=dict)
+    meta: Mapped[Optional[Dict[str, Any]]] = mapped_column(JSON, default=dict)
     created: Mapped[dt_create]
     updated: Mapped[dt_update]
 
@@ -1070,6 +1113,8 @@ class Achievement_x_User(Base):
     Attributes:
         achievement_id (int): The ID of the associated achievement.
         user_id (int): The ID of the associated user.
+        award_year (int): The year the achievement was awarded. Default is -1 (used for lifetime achievements).
+        award_period (int): The period (ie week, month) the achievement was awarded in. Default is -1 (used for lifetime achievements).
         date_awarded (date): The date the achievement was awarded. Default is the current date.
     """  # noqa: E501
 
@@ -1077,6 +1122,8 @@ class Achievement_x_User(Base):
 
     achievement_id: Mapped[int] = mapped_column(ForeignKey("achievements.id"), primary_key=True)
     user_id: Mapped[int] = mapped_column(ForeignKey("users.id"), primary_key=True)
+    award_year: Mapped[int] = mapped_column(Integer, primary_key=True, server_default="-1")
+    award_period: Mapped[int] = mapped_column(Integer, primary_key=True, server_default="-1")
     date_awarded: Mapped[date] = mapped_column(DateTime, server_default=func.timezone("utc", func.now()))
 
 

{f3_data_models-0.5.15 → f3_data_models-0.5.17}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "f3-data-models"
-version = "0.5.15"
+version = "0.5.17"
 description = "The data schema and models for F3 Nation applications."
 authors = ["Evan Petzoldt <evan.petzoldt@protonmail.com>"]
 readme = "README.md"