Habiticalib 0.1.0a3__py3-none-any.whl → 0.2.0__py3-none-any.whl

habiticalib/__init__.py

@@ -8,17 +8,24 @@ from .exceptions import (
     NotFoundError,
     TooManyRequestsError,
 )
+from .helpers import deserialize_task
 from .lib import Habitica
 from .types import (
     Attributes,
+    ChangeClassData,
+    ContentData,
     Direction,
     Frequency,
     HabiticaClass,
     HabiticaClassSystemResponse,
+    HabiticaContentResponse,
     HabiticaErrorResponse,
+    HabiticaGroupMembersResponse,
     HabiticaLoginResponse,
+    HabiticaQuestResponse,
     HabiticaResponse,
     HabiticaScoreResponse,
+    HabiticaSleepResponse,
     HabiticaStatsResponse,
     HabiticaTagResponse,
     HabiticaTagsResponse,
@@ -28,10 +35,18 @@ from .types import (
     HabiticaUserExport,
     HabiticaUserResponse,
     Language,
+    LoginData,
+    QuestData,
+    ScoreData,
     Skill,
+    StatsUser,
+    TagsUser,
     Task,
+    TaskData,
     TaskFilter,
+    TaskPriority,
     TaskType,
+    UserData,
     UserStyles,
 )
 
@@ -40,17 +55,24 @@ __all__ = [
     "ASSETS_URL",
     "Attributes",
     "BadRequestError",
+    "ChangeClassData",
+    "ContentData",
     "DEFAULT_URL",
+    "deserialize_task",
     "Direction",
     "Frequency",
     "Habitica",
     "HabiticaClass",
     "HabiticaClassSystemResponse",
+    "HabiticaContentResponse",
     "HabiticaErrorResponse",
     "HabiticaException",
+    "HabiticaGroupMembersResponse",
     "HabiticaLoginResponse",
+    "HabiticaQuestResponse",
     "HabiticaResponse",
     "HabiticaScoreResponse",
+    "HabiticaSleepResponse",
     "HabiticaStatsResponse",
     "HabiticaTagResponse",
     "HabiticaTagsResponse",
@@ -60,12 +82,20 @@ __all__ = [
     "HabiticaUserExport",
     "HabiticaUserResponse",
     "Language",
+    "LoginData",
     "NotAuthorizedError",
     "NotFoundError",
+    "QuestData",
+    "ScoreData",
     "Skill",
+    "StatsUser",
+    "TagsUser",
     "Task",
+    "TaskData",
     "TaskFilter",
+    "TaskPriority",
     "TaskType",
     "TooManyRequestsError",
+    "UserData",
     "UserStyles",
 ]

habiticalib/const.py

@@ -1,6 +1,6 @@
 """Constants for Habiticalib."""
 
-__version__ = "0.1.0a3"
+__version__ = "0.2.0"
 
 DEFAULT_URL = "https://habitica.com/"
 ASSETS_URL = "https://habitica-assets.s3.amazonaws.com/mobileApp/images/"
@@ -14,3 +14,5 @@ BACKER_ONLY_GEAR = {
     "shield_special_ks2019": "BackerOnly-Equip-MythicGryphonShield.gif",
     "weapon_special_ks2019": "BackerOnly-Equip-MythicGryphonGlaive.gif",
 }
+
+PAGE_LIMIT = 60

habiticalib/lib.py

@@ -6,13 +6,14 @@ import asyncio
 from http import HTTPStatus
 from io import BytesIO
 import logging
-from typing import IO, TYPE_CHECKING, Self
+from typing import IO, TYPE_CHECKING, Any, Self
 
 from aiohttp import ClientError, ClientResponseError, ClientSession
+from habitipy.aio import HabitipyAsync  # type: ignore[import-untyped]
 from PIL import Image
 from yarl import URL
 
-from .const import ASSETS_URL, BACKER_ONLY_GEAR, DEFAULT_URL
+from .const import ASSETS_URL, BACKER_ONLY_GEAR, DEFAULT_URL, PAGE_LIMIT
 from .exceptions import (
     BadRequestError,
     NotAuthorizedError,
@@ -31,10 +32,14 @@ from .types import (
     Direction,
     HabiticaClass,
     HabiticaClassSystemResponse,
+    HabiticaContentResponse,
     HabiticaErrorResponse,
+    HabiticaGroupMembersResponse,
     HabiticaLoginResponse,
+    HabiticaQuestResponse,
     HabiticaResponse,
     HabiticaScoreResponse,
+    HabiticaSleepResponse,
     HabiticaStatsResponse,
     HabiticaTagResponse,
     HabiticaTagsResponse,
@@ -260,14 +265,15 @@ class Habitica:
         self,
         task_type: TaskFilter | None = None,
         due_date: datetime | None = None,
-    ) -> HabiticaResponse:
+    ) -> HabiticaTasksResponse:
         """Get the authenticated user's tasks.
 
         Parameters
         ----------
         task_type : TaskFilter | None
             The type of task to retrieve, defined in TaskFilter enum.
-            If `None`, all task types will be retrieved (default is None).
+            If `None`, all task types will be retrieved except completed to-dos
+            (default is None).
 
         due_date : datetime | None
             Optional date to use for computing the nextDue field for each returned task.
@@ -455,7 +461,7 @@ class Habitica:
         Returns
         -------
         HabiticaTaskResponse
-            A response object containing the data for the deleted task.
+            A response containing an empty data object.
 
         Raises
         ------
@@ -559,7 +565,7 @@ class Habitica:
     async def get_content(
         self,
         language: Language | None = None,
-    ) -> HabiticaResponse:
+    ) -> HabiticaContentResponse:
         """
         Fetch game content from the Habitica API.
 
@@ -601,7 +607,7 @@ class Habitica:
         if language:
             params.update({"language": language.value})
 
-        return HabiticaResponse.from_json(
+        return HabiticaContentResponse.from_json(
             await self._request("get", url=url, params=params),
         )
 
@@ -848,17 +854,17 @@ class Habitica:
         if target_id:
             params.update({"targetId": str(target_id)})
         return HabiticaUserResponse.from_json(
-            await self._request("post", url=url, json=params),
+            await self._request("post", url=url, params=params),
         )
 
     async def toggle_sleep(
         self,
-    ) -> HabiticaResponse:
+    ) -> HabiticaSleepResponse:
         """Toggles the user's sleep mode in Habitica.
 
         Returns
         -------
-        HabiticaResponse
+        HabiticaSleepResponse
             A response object containing the result of the sleep mode toggle,
             and the new sleep state (True if sleeping, False if not).
 
@@ -875,7 +881,7 @@ class Habitica:
         """
         url = self.url / "api/v3/user/sleep"
 
-        return HabiticaResponse.from_json(await self._request("post", url=url))
+        return HabiticaSleepResponse.from_json(await self._request("post", url=url))
 
     async def revive(
         self,
@@ -1280,6 +1286,443 @@ class Habitica:
             await self._request("post", url=url, json=json),
         )
 
+    async def get_group_members(
+        self,
+        group_id: UUID | None = None,
+        *,
+        limit: int | None = None,
+        tasks: bool = False,
+        public_fields: bool = False,
+        last_id: UUID | None = None,
+    ) -> HabiticaGroupMembersResponse:
+        """Get members of the party or a specific group.
+
+        This method retrieves a list of members for a party or a specified group
+        from the Habitica API. Additional options allow including tasks or public
+        through results if necessary to collect all members. If the API rate limit is
+        exceeded, the method will pause for the duration specified in the `retry-after`
+        header and retry the request.
+
+
+        Parameters
+        ----------
+        group_id : UUID, optional
+            The UUID of the group. Defaults to the user's party if not specified.
+        limit : int, optional
+            Maximum number of members per request (default: 30, max: 60).
+        tasks : bool, optional
+            Whether to include tasks associated with the group.
+        public_fields : bool, optional
+            Whether to include all public fields for group members.
+        last_id : UUID, optional
+            For paginated requests, the UUID of the last member retrieved.
+
+        Returns
+        -------
+        HabiticaGroupMembersResponse
+            A response object containing the group member data.
+
+        Raises
+        ------
+        aiohttp.ClientResponseError
+            For HTTP-related errors, such as HTTP 400 or 500 response status.
+        aiohttp.ClientConnectionError
+            If the connection to the API fails.
+        aiohttp.ClientError
+            For any other exceptions raised by aiohttp during the request.
+        TimeoutError
+            If the connection times out.
+
+        Examples
+        --------
+        >>> members_response = await habitica.get_group_members()
+        >>> for member in members_response.data:
+        ...     print(member.profile.name)
+        """
+
+        if limit is not None and (limit < 1 or limit > PAGE_LIMIT):
+            msg = f"The 'limit' parameter must be between 1 and {PAGE_LIMIT}."
+            raise ValueError(msg)
+
+        group = "party" if not group_id else str(group_id)
+        url = self.url / "api/v3/groups" / group / "members"
+
+        params: dict[str, str | int] = {}
+
+        if tasks:
+            params["includeTasks"] = "true"
+        if public_fields:
+            params["includeAllPublicFields"] = "true"
+        if last_id:
+            params["lastId"] = str(last_id)
+        if limit:
+            params["limit"] = limit
+
+        while True:
+            try:
+                response = HabiticaGroupMembersResponse.from_json(
+                    await self._request("get", url=url, params=params),
+                )
+                break
+            except TooManyRequestsError as e:
+                await asyncio.sleep(e.retry_after)
+
+        if len(response.data) == limit:
+            next_page = await self.get_group_members(
+                group_id=group_id,
+                limit=limit,
+                tasks=tasks,
+                public_fields=public_fields,
+                last_id=response.data[-1].id,
+            )
+            response.data.extend(next_page.data)
+
+        return response
+
+    async def abort_quest(self, group_id: UUID | None = None) -> HabiticaQuestResponse:
+        """Abort an active quest for the party or a specific group.
+
+        Prematurely terminates an ongoing quest, causing all progress to be lost.
+        The quest scroll will be returned to the owner's inventory.
+        Only the quest leader or group leader is allowed to perform this action.
+
+        Parameters
+        ----------
+        group_id : UUID, optional
+            The UUID of the specific group whose quest should be aborted.
+            Defaults to the user's party if not specified.
+
+        Returns
+        -------
+        HabiticaQuestResponse
+            A response object containing updated quest data of the group or party.
+
+        Raises
+        ------
+        NotFoundError
+            If the specified group or quest could not be found.
+        NotAuthorizedError
+            If the user does not have permission to abort the quest.
+        aiohttp.ClientResponseError
+            For HTTP-related errors, such as HTTP 400 or 500 response status.
+        aiohttp.ClientConnectionError
+            If the connection to the API fails.
+        aiohttp.ClientError
+            For any other exceptions raised by aiohttp during the request.
+        TimeoutError
+            If the connection times out.
+
+        Examples
+        --------
+        Abort the party's current quest:
+        >>> response = await habitica.abort_quest()
+        >>> print(response.success)  # True if the quest was successfully aborted.
+
+        Abort a quest for a specific group:
+        >>> group_id = UUID("12345678-1234-5678-1234-567812345678")
+        >>> response = await habitica.abort_quest(group_id)
+        >>> print(response.success)  # True if the quest was successfully aborted.
+        """
+        group = "party" if not group_id else str(group_id)
+        url = self.url / "api/v3/groups" / group / "quests/abort"
+
+        return HabiticaQuestResponse.from_json(
+            await self._request("post", url=url),
+        )
+
+    async def accept_quest(self, group_id: UUID | None = None) -> HabiticaQuestResponse:
+        """Accept a pending invitation to a quest from the party or a specific group.
+
+        Allows a user to accept an invitation to participate in a quest within a
+        specified group.
+
+        Parameters
+        ----------
+        group_id : UUID, optional
+            The UUID of the group for which the quest invitation is being accepted.
+            Defaults to the user's party if not specified.
+
+
+        Returns
+        -------
+        HabiticaQuestResponse
+            A response object containing updated quest data of the group or party.
+
+        Raises
+        ------
+        NotFoundError
+            If the specified group or quest could not be found.
+        aiohttp.ClientResponseError
+            Raised for HTTP-related errors, such as HTTP 400 or 500 response status.
+        aiohttp.ClientConnectionError
+            If the connection to the API fails.
+        aiohttp.ClientError
+            Raised for any other exceptions encountered by `aiohttp` during the request.
+        TimeoutError
+            If the connection to the API times out.
+
+        Examples
+        --------
+        Accept a pending quest invitation from the party:
+        >>> response = await habitica.accept_quest()
+        >>> print(response.success)  # True if the quest invitation was successfully accepted.
+        """
+        group = "party" if not group_id else str(group_id)
+        url = self.url / "api/v3/groups" / group / "quests/accept"
+
+        return HabiticaQuestResponse.from_json(
+            await self._request("post", url=url),
+        )
+
+    async def reject_quest(self, group_id: UUID | None = None) -> HabiticaQuestResponse:
+        """Reject a pending quest invitation from the party or a specific group.
+
+        Allows a user to reject an invitation to participate in a quest within a
+        specified group. The user will not join the quest and will be excluded from
+        its progress and rewards.
+
+        Parameters
+        ----------
+        group_id : UUID, optional
+            The UUID of the group for which the quest invitation is being rejected.
+            Defaults to the user's party if not specified.
+
+
+        Returns
+        -------
+        HabiticaQuestResponse
+            A response object containing updated quest data of the group or party.
+
+        Raises
+        ------
+        NotFoundError
+            If the specified group or quest could not be found.
+        aiohttp.ClientResponseError
+            Raised for HTTP-related errors, such as HTTP 400 or 500 response status.
+        aiohttp.ClientConnectionError
+            If the connection to the API fails.
+        aiohttp.ClientError
+            Raised for any other exceptions encountered by `aiohttp` during the request.
+        TimeoutError
+            If the connection to the API times out.
+
+        Examples
+        --------
+        Reject a pending quest invitation from the party:
+        >>> response = await habitica.reject_quest()
+        >>> print(response.success)  # True if the quest invitation was successfully rejected.
+
+        Reject a pending quest invitation from a specific group:
+        >>> group_id = UUID("12345678-1234-5678-1234-567812345678")
+        >>> response = await habitica.reject_quest(group_id)
+        >>> print(response.success)  # True if the quest invitation was successfully rejected.
+        """
+        group = "party" if not group_id else str(group_id)
+        url = self.url / "api/v3/groups" / group / "quests/reject"
+
+        return HabiticaQuestResponse.from_json(
+            await self._request("post", url=url),
+        )
+
+    async def cancel_quest(self, group_id: UUID | None = None) -> HabiticaQuestResponse:
+        """Cancel a pending quest for the party or a specific group.
+
+        Cancel a quest that has not yet startet. All accepted and pending invitations
+        will be canceled and the quest roll returned to the owner's inventory.
+        Only quest leader or group leader can perform this action.
+
+        Parameters
+        ----------
+        group_id : UUID, optional
+            The UUID of the group for which the quest is being canceled.
+            Defaults to the user's party if not specified.
+
+        Returns
+        -------
+        HabiticaQuestResponse
+            A response object containing details about the canceled quest.
+
+        Raises
+        ------
+        NotFoundError
+            If the specified group or quest could not be found.
+        NotAuthorizedError
+            If the user does not have permission to cancel the quest.
+        aiohttp.ClientResponseError
+            Raised for HTTP-related errors, such as HTTP 400 or 500 response status.
+        aiohttp.ClientConnectionError
+            If the connection to the API fails.
+        aiohttp.ClientError
+            Raised for any other exceptions encountered by `aiohttp` during the request.
+        TimeoutError
+            If the connection to the API times out.
+
+        Examples
+        --------
+        Cancel a pending quest for the party:
+        >>> response = await habitica.cancel_quest()
+        >>> print(response.success)  # True if the quest was successfully canceled.
+        """
+        group = "party" if not group_id else str(group_id)
+        url = self.url / "api/v3/groups" / group / "quests/cancel"
+
+        return HabiticaQuestResponse.from_json(
+            await self._request("post", url=url),
+        )
+
+    async def start_quest(self, group_id: UUID | None = None) -> HabiticaQuestResponse:
+        """Force-start a quest for the party or a specific group.
+
+        Begins a quest immediately, bypassing any pending invitations that haven't been
+        accepted or rejected.
+        Only quest leader or group leader can perform this action.
+
+        Parameters
+        ----------
+        group_id : UUID, optional
+            The UUID of the group for which the quest should be started.
+            Defaults to the user's party if not specified.
+
+
+        Returns
+        -------
+        HabiticaQuestResponse
+            A response object containing updated quest data of the group or party.
+
+        Raises
+        ------
+        NotFoundError
+            If the specified group or quest could not be found.
+        NotAuthorizedError
+            If the user does not have permission to start the quest.
+        aiohttp.ClientResponseError
+            Raised for HTTP-related errors, such as HTTP 400 or 500 response status.
+        aiohttp.ClientConnectionError
+            If the connection to the API fails.
+        aiohttp.ClientError
+            Raised for any other exceptions encountered by `aiohttp` during the request.
+        TimeoutError
+            If the connection to the API times out.
+
+        Examples
+        --------
+        Cancel a pending quest for the party:
+        >>> response = await habitica.cancel_quest()
+        >>> print(response.success)  # True if the quest was successfully canceled.
+        """
+        group = "party" if not group_id else str(group_id)
+        url = self.url / "api/v3/groups" / group / "quests/force-start"
+
+        return HabiticaQuestResponse.from_json(
+            await self._request("post", url=url),
+        )
+
+    async def invite_quest(
+        self,
+        group_id: UUID | None = None,
+        *,
+        quest_key: str,
+    ) -> HabiticaQuestResponse:
+        """Invite members of the party or a specific group to participate in a quest.
+
+        Sends invitations for a quest to all eligible members of the specified group.
+        The quest is started when all members accept or reject the invitation.
+
+        Parameters
+        ----------
+        group_id : UUID, optional
+            The UUID of the group for which the quest invitations should be sent.
+            Defaults to the user's party if not specified.
+        quest_key : str
+            The unique key identifying the quest to invite members to.
+
+        Returns
+        -------
+        HabiticaQuestResponse
+            A response object containing updated quest data of the group or party.
+
+        Raises
+        ------
+        NotFoundError
+            If the specified group or quest could not be found.
+        aiohttp.ClientResponseError
+            Raised for HTTP-related errors, such as HTTP 400 or 500 response status.
+        aiohttp.ClientConnectionError
+            If the connection to the API fails.
+        aiohttp.ClientError
+            Raised for any other exceptions encountered by `aiohttp` during the request.
+        TimeoutError
+            If the connection to the API times out.
+
+        Examples
+        --------
+        Send a quest invitation to the party:
+        >>> response = await habitica.invite_quest(quest_key="dilatory_derby")
+        >>> print(response.success)  # True if invitations were successfully sent.
+
+        Send a quest invitation to a specific group:
+        >>> group_id = UUID("12345678-1234-5678-1234-567812345678")
+        >>> response = await habitica.invite_quest(group_id, quest_key="golden_knight")
+        >>> print(response.success)  # True if invitations were successfully sent.
+        """
+        group = "party" if not group_id else str(group_id)
+        url = self.url / "api/v3/groups" / group / "quests/invite" / quest_key
+
+        return HabiticaQuestResponse.from_json(
+            await self._request("post", url=url),
+        )
+
+    async def leave_quest(self, group_id: UUID | None = None) -> HabiticaQuestResponse:
+        """Leave the current quest from the party or a specific group.
+
+        Allows a user to exit an ongoing quest they are part of. This action removes
+        them from the quest but does not affect its progress for other participants.
+        Users who leave a quest will not contribute to its completion or receive rewards.
+
+        Parameters
+        ----------
+        group_id : UUID, optional
+            The UUID of the group associated with the quest the user is leaving.
+            Defaults to the user's party if not specified.
+        quest_key : str
+            The unique key identifying the quest to invite members to.
+
+        Returns
+        -------
+        HabiticaQuestResponse
+            A response object containing updated quest data of the group or party.
+
+        Raises
+        ------
+        NotFoundError
+            If the specified group or quest could not be found.
+        aiohttp.ClientResponseError
+            Raised for HTTP-related errors, such as HTTP 400 or 500 response status.
+        aiohttp.ClientConnectionError
+            If the connection to the API fails.
+        aiohttp.ClientError
+            Raised for any other exceptions encountered by `aiohttp` during the request.
+        TimeoutError
+            If the connection to the API times out.
+
+        Examples
+        --------
+        Leave the current quest in the user's party:
+        >>> response = await habitica.leave_quest()
+        >>> print(response.success)  # True if the user successfully left the quest.
+
+        Leave the current quest in a specific group:
+        >>> group_id = UUID("12345678-1234-5678-1234-567812345678")
+        >>> response = await habitica.leave_quest(group_id)
+        >>> print(response.success)  # True if the user successfully left the quest.
+        """
+        group = "party" if not group_id else str(group_id)
+        url = self.url / "api/v3/groups" / group / "quests/leave"
+
+        return HabiticaQuestResponse.from_json(
+            await self._request("post", url=url),
+        )
+
     def _cache_asset(self, asset: str, asset_data: IO[bytes]) -> None:
         """Cache an asset and maintain the cache size limit by removing older entries.
 
@@ -1556,3 +1999,33 @@ class Habitica:
             image.save(fp, fmt)
 
         return user_styles
+
+    async def habitipy(self) -> HabitipyAsync:
+        """Create a Habitipy instance."""
+
+        _session = self._session
+        _headers = self._headers
+        loop = asyncio.get_running_loop()
+
+        class HAHabitipyAsync(HabitipyAsync):
+            """Closure API class to hold session."""
+
+            def __call__(self, **kwargs) -> Any:
+                """Pass session to habitipy."""
+                return super().__call__(_session, **kwargs)
+
+            def _make_headers(self) -> dict[str, str]:
+                """Inject headers."""
+                headers = super()._make_headers()
+                headers.update(_headers)
+                return headers
+
+        return await loop.run_in_executor(
+            None,
+            HAHabitipyAsync,
+            {
+                "url": str(self.url),
+                "login": self._headers.get("X-API-USER"),
+                "password": self._headers.get("X-API-KEY"),
+            },  # type: ignore[var-annotated]
+        )

habiticalib/types.py

@@ -591,7 +591,7 @@ class PreferencesUser:
     webhooks: dict = field(default_factory=dict)
     improvementCategories: list[str] = field(default_factory=list)
     timezoneOffsetAtLastCron: int | None = None
-    language: str | None = None
+    language: Language | None = None
 
 
 @dataclass(kw_only=True)
@@ -662,13 +662,6 @@ class StatsUser:
     Int: int | None = field(default=None, metadata=field_options(alias="int"))
 
 
-field(
-    metadata=field_options(
-        deserialize=serialize_datetime,
-    )
-)
-
-
 @dataclass(kw_only=True)
 class TagsUser:
     """Tags user data."""
@@ -777,6 +770,13 @@ class HabiticaUserResponse(HabiticaResponse):
     data: UserData
 
 
+@dataclass(kw_only=True)
+class HabiticaGroupMembersResponse(HabiticaResponse):
+    """Representation of a group members data response."""
+
+    data: list[UserData]
+
+
 @dataclass(kw_only=True)
 class CompletedBy:
     """Task group completedby data."""
@@ -1107,6 +1107,25 @@ class HabiticaTagResponse(HabiticaResponse, DataClassORJSONMixin):
     data: TagsUser
 
 
+@dataclass(kw_only=True)
+class QuestData:
+    """Quest data."""
+
+    progress: ProgressQuest = field(default_factory=ProgressQuest)
+    active: bool = False
+    members: dict[str, bool | None]
+    extra: dict | None = None
+    key: str
+    leader: UUID | None = None
+
+
+@dataclass(kw_only=True)
+class HabiticaQuestResponse(HabiticaResponse, DataClassORJSONMixin):
+    """Representation of a quest response."""
+
+    data: QuestData
+
+
 @dataclass
 class ChangeClassData:
     """Change class data."""
@@ -1131,6 +1150,13 @@ class HabiticaTaskOrderResponse(HabiticaResponse):
     data: list[UUID] = field(default_factory=list)
 
 
+@dataclass
+class HabiticaSleepResponse(HabiticaResponse):
+    """Representation of a sleep response."""
+
+    data: bool
+
+
 class TaskFilter(StrEnum):
     """Enum representing the valid types of tasks for requests."""
 
@@ -1187,7 +1213,7 @@ class Skill(StrEnum):
     VALOROUS_PRESENCE = "valorousPresence"
     INTIMIDATING_GAZE = "intimidate"
     # Rogue skills
-    PICKPOCKET = "Pickpocket"
+    PICKPOCKET = "pickPocket"
     BACKSTAB = "backStab"
     TOOLS_OF_THE_TRADE = "toolsOfTrade"
     STEALTH = "stealth"
@@ -1222,3 +1248,387 @@ class TaskPriority(Enum):
     EASY = 1
     MEDIUM = 1.5
     HARD = 2
+
+
+@dataclass
+class AchievmentContent:
+    """Achievment content data."""
+
+    icon: str
+    key: str
+    titleKey: str | None = None
+    textKey: str | None = None
+    singularTitleKey: str | None = None
+    singularTextKey: str | None = None
+    pluralTitleKey: str | None = None
+    pluralTextKey: str | None = None
+
+
+@dataclass
+class AnimalColorAchievementContent:
+    """animalColorAchievement content data."""
+
+    color: str
+    petAchievement: str
+    petNotificationType: str
+    mountAchievement: str
+    mountNotificationType: str
+
+
+@dataclass
+class AnimalSetAchievementContent:
+    """animalSetAchievements content data."""
+
+    Type: str = field(metadata=field_options(alias="type"))
+    species: list[str]
+    achievementKey: str
+    notificationType: str
+
+
+@dataclass
+class StableAchievementContent:
+    """stableAchievements content data."""
+
+    masterAchievement: str
+    masterNotificationType: str
+
+
+@dataclass
+class PetSetCompleteAchievsContent:
+    """petSetCompleteAchievs content data."""
+
+    color: str
+    petAchievement: str
+    petNotificationType: str
+
+
+@dataclass
+class QuestBossRage:
+    """QuestBossRage content data."""
+
+    title: str
+    description: str
+    value: float
+    effect: str | None = None
+    healing: float | None = None
+
+
+@dataclass
+class QuestBoss:
+    """QuestBoss content data."""
+
+    name: str
+    hp: float
+    Str: float = field(metadata=field_options(alias="str"))
+    Def: float = field(metadata=field_options(alias="def"))
+    rage: QuestBossRage | None = None
+
+
+@dataclass
+class QuestItem:
+    """QuestItem content data."""
+
+    Type: str = field(metadata=field_options(alias="type"))
+    key: str
+    text: str
+
+
+@dataclass
+class QuestDrop:
+    """QuestDrop content data."""
+
+    gp: float
+    exp: float
+    items: list[QuestItem] | None = None
+
+
+@dataclass
+class QuestCollect:
+    """QuestCollect content data."""
+
+    text: str
+    count: int
+
+
+@dataclass
+class QuestUnlockCondition:
+    """QuestUnlockCondition content data."""
+
+    condition: str
+    text: str
+
+
+@dataclass
+class QuestsContent:
+    """petSetCompleteAchievs content data."""
+
+    text: str
+    notes: str
+
+    completion: str
+    category: str
+
+    drop: QuestDrop
+    key: str
+    goldValue: float | None = None
+    value: float | None = None
+    previous: str | None = None
+    prereqQuests: list[str] | None = None
+    collect: dict[str, QuestCollect] | None = None
+    unlockCondition: QuestUnlockCondition | None = None
+    boss: QuestBoss | None = None
+    group: str | None = None
+
+
+@dataclass
+class ItemListEntry:
+    """ItemListEntry content data."""
+
+    localeKey: str
+    isEquipment: bool
+
+
+@dataclass
+class ItemListContent:
+    """ItemListContent content data."""
+
+    weapon: ItemListEntry
+    armor: ItemListEntry
+    head: ItemListEntry
+    shield: ItemListEntry
+    back: ItemListEntry
+    body: ItemListEntry
+    headAccessory: ItemListEntry
+    eyewear: ItemListEntry
+    hatchingPotions: ItemListEntry
+    premiumHatchingPotions: ItemListEntry
+    eggs: ItemListEntry
+    quests: ItemListEntry
+    food: ItemListEntry
+    Saddle: ItemListEntry
+    bundles: ItemListEntry
+
+
+@dataclass
+class GearEntry:
+    """GearEntry content data."""
+
+    text: str
+    notes: str
+    Int: int = field(metadata=field_options(alias="int"))
+    value: int
+    Type: str = field(metadata=field_options(alias="type"))
+    key: str
+    Set: str = field(metadata=field_options(alias="set"))
+    klass: str
+    index: str
+    Str: int = field(metadata=field_options(alias="str"))
+    per: int
+    con: int
+
+
+@dataclass
+class GearClass:
+    """GearClass content data."""
+
+    base: dict[str, GearEntry] | None = None
+    warrior: dict[str, GearEntry] | None = None
+    wizard: dict[str, GearEntry] | None = None
+    rogue: dict[str, GearEntry] | None = None
+    special: dict[str, GearEntry] | None = None
+    armoire: dict[str, GearEntry] | None = None
+    mystery: dict[str, GearEntry] | None = None
+    healer: dict[str, GearEntry] | None = None
+
+
+@dataclass
+class GearType:
+    """GearType content data."""
+
+    weapon: GearClass
+    armor: GearClass
+    head: GearClass
+    shield: GearClass
+    back: GearClass
+    body: GearClass
+    headAccessory: GearClass
+    eyewear: GearClass
+
+
+@dataclass
+class GearContent:
+    """GearContent content data."""
+
+    tree: GearType
+    flat: dict[str, GearEntry]
+
+
+@dataclass
+class SpellEntry:
+    """SpellEntry content data."""
+
+    text: str
+    mana: int
+    target: str
+    notes: str
+    key: str
+    previousPurchase: bool | None = None
+    limited: bool | None = None
+    lvl: int | None = None
+    value: int | None = None
+    immediateUse: bool | None = None
+    purchaseType: str | None = None
+    silent: bool | None = None
+
+
+@dataclass
+class SpellsClass:
+    """SpellsClass content data."""
+
+    wizard: dict[str, SpellEntry]
+    warrior: dict[str, SpellEntry]
+    rogue: dict[str, SpellEntry]
+    healer: dict[str, SpellEntry]
+    special: dict[str, SpellEntry]
+
+
+@dataclass
+class CarTypes:
+    """CarTypes content data."""
+
+    key: str
+    messageOptions: int
+    yearRound: bool = False
+
+
+@dataclass
+class SpecialItemEntry:
+    """Item content data."""
+
+    key: str | None = None
+    text: str | None = None
+    notes: str | None = None
+    immediateUse: bool | None = None
+    limited: bool | None = None
+    mana: int | None = None
+    previousPurchase: bool | None = None
+    purchaseType: str | None = None
+    silent: bool | None = None
+    target: str | None = None
+    value: int | None = None
+
+
+@dataclass
+class EggEntry:
+    """Egg content data."""
+
+    text: str | None = None
+    mountText: str | None = None
+    adjective: str | None = None
+    value: int | None = None
+    key: str | None = None
+    notes: str | None = None
+
+
+@dataclass
+class HatchingPotionEntry:
+    """Hatching potion content data."""
+
+    value: int | None = None
+    key: str | None = None
+    text: str | None = None
+    notes: str | None = None
+    premium: bool | None = None
+    limited: bool | None = None
+    _addlNotes: str | None = None
+    wacky: bool | None = None
+
+
+@dataclass
+class PetEntry:
+    """Pet content data."""
+
+    key: str | None = None
+    Type: str | None = field(default=None, metadata=field_options(alias="type"))
+    potion: str | None = None
+    egg: str | None = None
+    text: str | None = None
+
+
+@dataclass
+class InventoryItemEntry:
+    """Inventory item content data."""
+
+    text: str | None = None
+    textA: str | None = None
+    textThe: str | None = None
+    target: str | None = None
+    value: int | None = None
+    key: str | None = None
+    notes: str | None = None
+    canDrop: bool | None = None
+
+
+@dataclass
+class ContentData:
+    """Content data."""
+
+    achievements: dict[str, AchievmentContent]
+    questSeriesAchievements: dict[str, list[str]]
+    animalColorAchievements: list[AnimalColorAchievementContent]
+    animalSetAchievements: dict[str, AnimalSetAchievementContent]
+    stableAchievements: dict[str, StableAchievementContent]
+    petSetCompleteAchievs: list[PetSetCompleteAchievsContent]
+    quests: dict[str, QuestsContent]
+    questsByLevel: list[QuestsContent]
+    userCanOwnQuestCategories: list[str]
+    itemList: ItemListContent
+    gear: GearContent
+    spells: SpellsClass
+    audioThemes: list[str]
+    # mystery
+    officialPinnedItems: list
+    # bundles
+    # potion
+    # armoire
+    # events
+    # repeatingEvents
+    classes: list[str]
+    gearTypes: list[str]
+    cardTypes: dict[str, CarTypes]
+    special: dict[str, SpecialItemEntry]
+    dropEggs: dict[str, EggEntry]
+    questEggs: dict[str, EggEntry]
+    eggs: dict[str, EggEntry]
+    # timeTravelStable
+    dropHatchingPotions: dict[str, HatchingPotionEntry]
+    premiumHatchingPotions: dict[str, HatchingPotionEntry]
+    wackyHatchingPotions: dict[str, HatchingPotionEntry]
+    hatchingPotions: dict[str, HatchingPotionEntry]
+    pets: dict[str, bool]
+    premiumPets: dict[str, bool]
+    questPets: dict[str, bool]
+    specialPets: dict[str, str]
+    wackyPets: dict[str, bool]
+    petInfo: dict[str, PetEntry]
+    mounts: dict[str, bool]
+    premiumMounts: dict[str, bool]
+    questMounts: dict[str, bool]
+    specialMounts: dict[str, str]
+    mountInfo: dict[str, PetEntry]
+    food: dict[str, InventoryItemEntry]
+    # appearances
+    # backgrounds
+    # backgroundsFlat
+    # userDefaults
+    # tasksByCategory
+    # userDefaultsMobile
+    # faq
+    # loginIncentives
+
+
+@dataclass
+class HabiticaContentResponse(HabiticaResponse):
+    """Representation of a content response."""
+
+    data: ContentData

{habiticalib-0.1.0a3.dist-info → habiticalib-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: Habiticalib
-Version: 0.1.0a3
+Version: 0.2.0
 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
@@ -11,6 +11,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.12
 Requires-Dist: aiohttp~=3.9
+Requires-Dist: habitipy~=0.3.3
 Requires-Dist: mashumaro~=3.13
 Requires-Dist: orjson~=3.10
 Requires-Dist: pillow~=11.0

habiticalib-0.2.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+habiticalib/__init__.py,sha256=Mo0G1V_RKbIiAGYMWqznhOLtMxCM2UAmCqHW5JBEryw,2201
+habiticalib/const.py,sha256=pqAPlZylW8FyBWg31nixggB3u9mLksdo_D0nyLJulfM,624
+habiticalib/exceptions.py,sha256=oVFCGbHkVn0UpIKIPZPzXfvzs9US4R05ebdEn6cOpqM,1350
+habiticalib/helpers.py,sha256=IRZLYWkDVLI0iVBgBMmvZ6L83KCUl-CnzGhUR_tP6Fg,4576
+habiticalib/lib.py,sha256=woSpO1YeFv2d1BtHM1pKR1S4FmzbMnqSM0SAgQpupFU,72405
+habiticalib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+habiticalib/types.py,sha256=zJq3jnZNUSU0p5XX_14PpGHmxmCeuf1F_YQjFpcoMLo,42341
+habiticalib-0.2.0.dist-info/METADATA,sha256=G5slvwHpL9ELZkJRjE_e8YUw4UFdNPuTEvcfC59M1Po,4185
+habiticalib-0.2.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+habiticalib-0.2.0.dist-info/licenses/LICENSE,sha256=oIinIOSJ49l1iVIRI3XGXFWt6SF7a83kEFBAY8ORwNI,1084
+habiticalib-0.2.0.dist-info/RECORD,,

habiticalib-0.1.0a3.dist-info/RECORD

@@ -1,11 +0,0 @@
-habiticalib/__init__.py,sha256=rwRSTk3JFaSnVKRniTC82tA5JKPSuQ-AD_mAok2QU_g,1561
-habiticalib/const.py,sha256=aeFLubB_xXy_3ChIDmT9Atp_aOe58oOqcAs6vepIsoI,609
-habiticalib/exceptions.py,sha256=oVFCGbHkVn0UpIKIPZPzXfvzs9US4R05ebdEn6cOpqM,1350
-habiticalib/helpers.py,sha256=IRZLYWkDVLI0iVBgBMmvZ6L83KCUl-CnzGhUR_tP6Fg,4576
-habiticalib/lib.py,sha256=MMs3BINdbZUszUy_DCWvFWDZKy2or1UA5R47X3GeUwI,54274
-habiticalib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-habiticalib/types.py,sha256=7xpxpvpDQBxsyuD241vQxeXjk6zuEC4yXzw-Of7G7Bw,33187
-habiticalib-0.1.0a3.dist-info/METADATA,sha256=fmMClL_kOz3sWYotJu9QZT49CfV6sEcq9sq0bfV7YZ8,4156
-habiticalib-0.1.0a3.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-habiticalib-0.1.0a3.dist-info/licenses/LICENSE,sha256=oIinIOSJ49l1iVIRI3XGXFWt6SF7a83kEFBAY8ORwNI,1084
-habiticalib-0.1.0a3.dist-info/RECORD,,