Habiticalib 0.3.7rc1__py3-none-any.whl → 0.4.0rc0__py3-none-any.whl

habiticalib/__init__.py

@@ -46,11 +46,17 @@ from .typedefs import (
     GearItems,
     GearItemsAvatar,
     GearType,
+    GlobalActivity,
+    GlobalActivityWebhook,
+    GroupChatReceived,
+    GroupChatReceivedOptions,
+    GroupChatReceivedWebhook,
     GroupTask,
     HabiticaCastSkillResponse,
     HabiticaClass,
     HabiticaClassSystemResponse,
     HabiticaContentResponse,
+    HabiticaDeleteWebhookResponse,
     HabiticaErrorResponse,
     HabiticaGroupMembersResponse,
     HabiticaLoginResponse,
@@ -67,6 +73,7 @@ from .typedefs import (
     HabiticaUserAnonymizedResponse,
     HabiticaUserExport,
     HabiticaUserResponse,
+    HabiticaWebhookResponse,
     HairPreferences,
     HatchingPotionEntry,
     HistoryUser,
@@ -98,6 +105,9 @@ from .typedefs import (
     PurchasedUser,
     PushDevicesUser,
     PushNotificationsPreferences,
+    QuestActivity,
+    QuestActivityOptions,
+    QuestActivityWebhook,
     QuestBoss,
     QuestBossRage,
     QuestCollect,
@@ -123,6 +133,9 @@ from .typedefs import (
     SuppressModalsPreferences,
     TagsUser,
     Task,
+    TaskActivity,
+    TaskActivityOptions,
+    TaskActivityWebhook,
     TaskData,
     TaskFilter,
     TaskPriority,
@@ -135,12 +148,13 @@ from .typedefs import (
     TrainingStats,
     TutorialFlags,
     UltimateGearSetsAchievments,
+    UserActivity,
+    UserActivityOptions,
+    UserActivityWebhook,
     UserAnonymizedData,
     UserData,
     UserTasks,
-    WebhooksOptions,
-    WebhooksType,
-    WebhooksUser,
+    WebhookType,
 )
 
 __all__ = [
@@ -185,6 +199,11 @@ __all__ = [
     "GearItems",
     "GearItemsAvatar",
     "GearType",
+    "GlobalActivity",
+    "GlobalActivityWebhook",
+    "GroupChatReceived",
+    "GroupChatReceivedOptions",
+    "GroupChatReceivedWebhook",
     "GroupTask",
     "Habitica",
     "HabiticaCastSkillResponse",
@@ -194,6 +213,7 @@ __all__ = [
     "HabiticaClassSystemResponse",
     "HabiticaContentResponse",
     "HabiticaContentResponse",
+    "HabiticaDeleteWebhookResponse",
     "HabiticaErrorResponse",
     "HabiticaErrorResponse",
     "HabiticaException",
@@ -227,6 +247,7 @@ __all__ = [
     "HabiticaUserExport",
     "HabiticaUserResponse",
     "HabiticaUserResponse",
+    "HabiticaWebhookResponse",
     "HairPreferences",
     "HatchingPotionEntry",
     "HistoryUser",
@@ -261,6 +282,9 @@ __all__ = [
     "PurchasedUser",
     "PushDevicesUser",
     "PushNotificationsPreferences",
+    "QuestActivity",
+    "QuestActivityOptions",
+    "QuestActivityWebhook",
     "QuestBoss",
     "QuestBossRage",
     "QuestCollect",
@@ -291,6 +315,9 @@ __all__ = [
     "TagsUser",
     "TagsUser",
     "Task",
+    "TaskActivity",
+    "TaskActivityOptions",
+    "TaskActivityWebhook",
     "TaskData",
     "TaskData",
     "TaskFilter",
@@ -305,15 +332,16 @@ __all__ = [
     "TrainingStats",
     "TutorialFlags",
     "UltimateGearSetsAchievments",
+    "UserActivity",
+    "UserActivityOptions",
+    "UserActivityWebhook",
     "UserAnonymizedData",
     "UserAnonymizedData",
     "UserData",
     "UserData",
     "UserTasks",
     "UserTasks",
-    "WebhooksOptions",
-    "WebhooksType",
-    "WebhooksUser",
+    "WebhookType",
     "__version__",
     "deserialize_task",
     "extract_avatar",

habiticalib/const.py

@@ -1,6 +1,6 @@
 """Constants for Habiticalib."""
 
-__version__ = "0.3.7rc1"
+__version__ = "0.4.0rc0"
 
 DEFAULT_URL = "https://habitica.com/"
 ASSETS_URL = "https://habitica-assets.s3.amazonaws.com/mobileApp/images/"

habiticalib/lib.py

@@ -38,10 +38,13 @@ from .typedefs import (
     Attributes,
     Avatar,
     Direction,
+    GlobalActivity,
+    GroupChatReceived,
     HabiticaCastSkillResponse,
     HabiticaClass,
     HabiticaClassSystemResponse,
     HabiticaContentResponse,
+    HabiticaDeleteWebhookResponse,
     HabiticaErrorResponse,
     HabiticaGroupMembersResponse,
     HabiticaLoginResponse,
@@ -58,10 +61,14 @@ from .typedefs import (
     HabiticaUserAnonymizedResponse,
     HabiticaUserExport,
     HabiticaUserResponse,
+    HabiticaWebhookResponse,
     Language,
+    QuestActivity,
     Skill,
     Task,
+    TaskActivity,
     TaskFilter,
+    UserActivity,
 )
 
 if TYPE_CHECKING:
@@ -2073,3 +2080,106 @@ class Habitica:
                 "password": self._headers.get("X-API-KEY"),
             },  # type: ignore[var-annotated]
         )
+
+    async def create_webhook(
+        self,
+        webhook: TaskActivity
+        | GroupChatReceived
+        | UserActivity
+        | QuestActivity
+        | GlobalActivity,
+    ) -> HabiticaWebhookResponse:
+        """Create a new webhook.
+
+        Parameters
+        ----------
+        webhook : TaskActivity or GroupChatReceived or UserActivity or QuestActivity or GlobalActivity
+            The webhook object to be created. It should be an instance of one of the following types:
+            - TaskActivity
+            - GroupChatReceived
+            - UserActivity
+            - QuestActivity
+            - GlobalActivity
+
+        Returns
+        -------
+        HabiticaWebhookResponse
+            A response object containing the created webhook.
+
+        Raises
+        ------
+        BadRequestError
+            A parameter did not pass validation.
+
+        """
+
+        url = self.url / "api/v3/user/webhook"
+
+        return HabiticaWebhookResponse.from_json(
+            await self._request("post", url=url, json=webhook.to_dict(omit_none=True))
+        )
+
+    async def delete_webhook(
+        self, webhook_id: str | UUID
+    ) -> HabiticaDeleteWebhookResponse:
+        """Delete a webhook by its UUID.
+
+        Parameters
+        ----------
+        webhook_id : str or UUID
+            The UUID identifier of the webhook to delete.
+
+        Returns
+        -------
+        HabiticaDeleteWebhookResponse
+            A response object containing a list of the remaining webhooks.
+
+        Raises
+        ------
+        NotFoundError
+            The specified webhook could not be found.
+        """
+        url = self.url / "api/v3/user/webhook" / str(webhook_id)
+
+        return HabiticaDeleteWebhookResponse.from_json(
+            await self._request("delete", url)
+        )
+
+    async def update_webhook(
+        self,
+        webhook: TaskActivity
+        | GroupChatReceived
+        | UserActivity
+        | QuestActivity
+        | GlobalActivity,
+    ) -> HabiticaWebhookResponse:
+        """Update a webhook by its UUID with the provided data.
+
+        Parameters
+        ----------
+        webhook : TaskActivity or GroupChatReceived or UserActivity or QuestActivity or GlobalActivity
+            The webhook data to be updated. It must be an instance of one of the specified types.
+
+        Returns
+        -------
+        HabiticaWebhookResponse
+            The response object containing the updated webhook.
+
+
+        Raises
+        ------
+        ValueError
+            If the identifier was not provided.
+        BadRequestError
+            A parameter did not pass validation.
+
+        """
+        if not webhook.id:
+            msg = "You must provide the identifier of the webhook to update."
+            raise ValueError(msg)
+
+        url = self.url / "api/v3/user/webhook" / str(webhook.id)
+
+        return HabiticaWebhookResponse.from_json(
+            await self._request("put", url, json=webhook.to_dict(omit_none=True))
+        )

habiticalib/typedefs.py

@@ -7,12 +7,13 @@ from dataclasses import dataclass, field
 import datetime as dt
 from datetime import UTC, datetime
 from enum import Enum, StrEnum
-from typing import Any, NotRequired, TypedDict
+from typing import Annotated, Any, NotRequired, TypedDict
 from uuid import UUID
 
 from mashumaro import field_options
 from mashumaro.config import TO_DICT_ADD_OMIT_NONE_FLAG
 from mashumaro.mixins.orjson import DataClassORJSONMixin
+from mashumaro.types import Discriminator
 
 
 def serialize_datetime(date: str | int | None) -> datetime | None:
@@ -776,48 +777,187 @@ class PushDevicesUser(BaseModel):
     updatedAt: datetime
 
 
-class WebhooksType(StrEnum):
+class WebhookType(StrEnum):
     """Webhook types."""
 
     TASK_ACTIVITY = "taskActivity"
     USER_ACTIVITY = "userActivity"
     QUEST_ACTIVITY = "questActivity"
     GROUP_CHAT_RECEIVED = "groupChatReceived"
+    GLOBAL_ACTIVITY = "globalActivity"
 
 
 @dataclass(kw_only=True)
-class WebhooksOptions(BaseModel):
-    """Webhooks options data."""
+class QuestActivityOptions(BaseModel):
+    """Quest activity options."""
 
-    created: bool | None = None
-    updated: bool | None = None
-    deleted: bool | None = None
-    scored: bool | None = None
-    questStarted: bool | None = None
-    questFinished: bool | None = None
-    questInvited: bool | None = None
-    petHatched: bool | None = None
-    mountRaised: bool | None = None
-    leveledUp: bool | None = None
-    groupId: UUID | None = None
+    questStarted: bool = False
+    questFinished: bool = False
+    questInvited: bool = False
 
 
 @dataclass(kw_only=True)
-class WebhooksUser(BaseModel):
-    """Webhooks user data."""
+class UserActivityOptions(BaseModel):
+    """User activity options."""
+
+    petHatched: bool = False
+    mountRaised: bool = False
+    leveledUp: bool = False
 
+
+@dataclass
+class GroupChatReceivedOptions(BaseModel):
+    """Group chat received options."""
+
+    groupId: UUID
+
+
+@dataclass(kw_only=True)
+class TaskActivityOptions(BaseModel):
+    """Task activity options."""
+
+    created: bool = False
+    updated: bool = False
+    deleted: bool = False
+    checklistScored: bool = False
+    scored: bool = True
+
+
+@dataclass(kw_only=True)
+class Webhook(BaseModel):
+    """Webhook base class."""
+
+    url: str | None = field(default=None, kw_only=False)
+    enabled: bool | None = None
+    label: str | None = None
     id: UUID | None = None
-    Type: WebhooksType = WebhooksType.TASK_ACTIVITY
-    url: str | None = None
-    enabled: bool = True
+
+
+@dataclass(kw_only=True)
+class TaskActivity(Webhook):
+    """Task activity."""
+
+    Type: WebhookType = field(default=WebhookType.TASK_ACTIVITY, init=False)
+    options: TaskActivityOptions = field(default_factory=TaskActivityOptions)
+
+
+@dataclass(kw_only=True)
+class GroupChatReceived(Webhook):
+    """Group chat received."""
+
+    def __post_init__(self) -> None:
+        """Initialize the GroupChatReceived class."""
+        if self.groupId:
+            if not isinstance(self.groupId, UUID):
+                self.groupId = UUID(self.groupId)
+
+            self.options = GroupChatReceivedOptions(groupId=self.groupId)
+            self.groupId = None
+
+    groupId: UUID | str | None = field(default=None, kw_only=False)
+    Type: WebhookType = field(default=WebhookType.GROUP_CHAT_RECEIVED, init=False)
+    options: GroupChatReceivedOptions = field(init=False)
+
+
+@dataclass(kw_only=True)
+class UserActivity(Webhook):
+    """User activity."""
+
+    Type: WebhookType = field(default=WebhookType.USER_ACTIVITY, init=False)
+    options: UserActivityOptions = field(default_factory=UserActivityOptions)
+
+
+@dataclass(kw_only=True)
+class QuestActivity(Webhook):
+    """Quest activity."""
+
+    Type: WebhookType = field(default=WebhookType.QUEST_ACTIVITY, init=False)
+    options: QuestActivityOptions = field(default_factory=QuestActivityOptions)
+
+
+@dataclass(kw_only=True)
+class GlobalActivity(Webhook):
+    """Global  activity.
+
+    Note: global webhooks send a request for every type of event
+    """
+
+    Type: WebhookType = field(default=WebhookType.GLOBAL_ACTIVITY, init=False)
+
+
+class HabiticaWebhookResponse(HabiticaResponse):
+    """Representation of a webhook data response."""
+
+    data: Annotated[
+        Webhook,
+        Discriminator(
+            field="type",
+            include_subtypes=True,
+        ),
+    ]
+
+
+class HabiticaDeleteWebhookResponse(HabiticaResponse):
+    """Representation of a delete webhook response."""
+
+    data: list[
+        Annotated[
+            Webhook,
+            Discriminator(
+                field="type",
+                include_subtypes=True,
+            ),
+        ]
+    ]
+
+
+@dataclass(kw_only=True)
+class WebhookUser(BaseModel):
+    """Webhooks user data."""
+
     failures: int = 0
-    label: str = ""
-    options = WebhooksOptions
     lastFailureAt: datetime | None = None
     createdAt: datetime | None = None
     updatedAt: datetime | None = None
 
 
+@dataclass(kw_only=True)
+class TaskActivityWebhook(WebhookUser, TaskActivity):
+    """Task activity webhook."""
+
+    type = "taskActivity"
+
+
+@dataclass(kw_only=True)
+class QuestActivityWebhook(WebhookUser, QuestActivity):
+    """Quest activity webhook."""
+
+    type = "questActivity"
+
+
+@dataclass(kw_only=True)
+class GlobalActivityWebhook(WebhookUser, GlobalActivity):
+    """Global activity webhook."""
+
+    type = "globalActivity"
+
+
+@dataclass(kw_only=True)
+class GroupChatReceivedWebhook(WebhookUser, GroupChatReceived):
+    """Group chat received webhook."""
+
+    type = "groupChatReceived"
+    groupId: None = None
+    options: GroupChatReceivedOptions = field(init=True)
+
+
+@dataclass(kw_only=True)
+class UserActivityWebhook(WebhookUser, UserActivity):
+    """User activity webhook."""
+
+    type = "userActivity"
+
+
 @dataclass(kw_only=True)
 class PinnedItemsUser(BaseModel):
     """PinnedItems user data."""
@@ -851,7 +991,15 @@ class UserData(Avatar, BaseModel):
     tasksOrder: TasksOrderUser = field(default_factory=TasksOrderUser)
     extra: dict = field(default_factory=dict)
     pushDevices: list[PushDevicesUser] = field(default_factory=list)
-    webhooks: list[WebhooksUser] = field(default_factory=list)
+    webhooks: list[
+        Annotated[
+            Webhook,
+            Discriminator(
+                field="type",
+                include_subtypes=True,
+            ),
+        ]
+    ] = field(default_factory=list)
     loginIncentives: int | None = None
     invitesSent: int | None = None
     pinnedItems: list[PinnedItemsUser] = field(default_factory=list)

{habiticalib-0.3.7rc1.dist-info → habiticalib-0.4.0rc0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Habiticalib
-Version: 0.3.7rc1
+Version: 0.4.0rc0
 Summary: Asynchronous Python client library for the Habitica API
 Project-URL: Documentation, https://tr4nt0r.github.io/habiticalib/
 Project-URL: Source, https://github.com/tr4nt0r/habiticalib

habiticalib-0.4.0rc0.dist-info/RECORD

@@ -0,0 +1,12 @@
+habiticalib/__init__.py,sha256=2IM9mDegpFIANIdatGTePbT4r1cilUtwNYs4Bups7So,7690
+habiticalib/const.py,sha256=Yh3d46unPdB1n6EMENXrpV_komBj3b1eDWwc9pdEaws,2311
+habiticalib/exceptions.py,sha256=i9hnCaMT5RbnTioFhwRYJkcC_bG9lMeUd2jJsWFVnVg,1342
+habiticalib/ha.py,sha256=rSzrs7ixLJH3ZtOFlcuKV2t1ZndT0VpuPhDsGqorkOs,20757
+habiticalib/helpers.py,sha256=lq2HBvqLsFo5_zckMnc7hzDsHLfyrcStpFUpet3ZuZY,4500
+habiticalib/lib.py,sha256=9CqfAIGBx-MJB08UAB81kczB2kD1W1aPYHjDfAvBmFY,76729
+habiticalib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+habiticalib/typedefs.py,sha256=pU7jfWAKMSvJO8QjTEgm_B0c6GONy1SZH2lTMUPPhrE,47834
+habiticalib-0.4.0rc0.dist-info/METADATA,sha256=w920G81BFg4JxgAuIwi93JIC-jXZ3zhuwBNOwtu3GWg,4210
+habiticalib-0.4.0rc0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+habiticalib-0.4.0rc0.dist-info/licenses/LICENSE,sha256=oIinIOSJ49l1iVIRI3XGXFWt6SF7a83kEFBAY8ORwNI,1084
+habiticalib-0.4.0rc0.dist-info/RECORD,,

habiticalib-0.3.7rc1.dist-info/RECORD

@@ -1,12 +0,0 @@
-habiticalib/__init__.py,sha256=ZUd6heFQJaJgNiseoSY2SfJzOHfGFdIiOHI-qf9fXuU,6940
-habiticalib/const.py,sha256=H2LnnOkR3qBIO9rGhndJiFtXwO-FdThjoTt3DkIzqsM,2311
-habiticalib/exceptions.py,sha256=i9hnCaMT5RbnTioFhwRYJkcC_bG9lMeUd2jJsWFVnVg,1342
-habiticalib/ha.py,sha256=rSzrs7ixLJH3ZtOFlcuKV2t1ZndT0VpuPhDsGqorkOs,20757
-habiticalib/helpers.py,sha256=lq2HBvqLsFo5_zckMnc7hzDsHLfyrcStpFUpet3ZuZY,4500
-habiticalib/lib.py,sha256=K6KwRBw_bq9wyXb5PJcZVlN2kF6zXiPm11Hk4XVHfqE,73598
-habiticalib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-habiticalib/typedefs.py,sha256=984f8IawG-L8XTinsNDmaiSJkgfIJk-vHBI44qRySNE,44343
-habiticalib-0.3.7rc1.dist-info/METADATA,sha256=pW_rpLjd26SZc6VSce_SK-MeAmquhVtwg69GEvGjfkQ,4210
-habiticalib-0.3.7rc1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-habiticalib-0.3.7rc1.dist-info/licenses/LICENSE,sha256=oIinIOSJ49l1iVIRI3XGXFWt6SF7a83kEFBAY8ORwNI,1084
-habiticalib-0.3.7rc1.dist-info/RECORD,,