Habiticalib 0.2.0a1__py3-none-any.whl → 0.2.0a2__py3-none-any.whl

habiticalib/__init__.py

@@ -15,9 +15,11 @@ from .types import (
     Frequency,
     HabiticaClass,
     HabiticaClassSystemResponse,
+    HabiticaContentResponse,
     HabiticaErrorResponse,
     HabiticaGroupMembersResponse,
     HabiticaLoginResponse,
+    HabiticaQuestResponse,
     HabiticaResponse,
     HabiticaScoreResponse,
     HabiticaSleepResponse,
@@ -48,10 +50,12 @@ __all__ = [
     "Habitica",
     "HabiticaClass",
     "HabiticaClassSystemResponse",
+    "HabiticaContentResponse",
     "HabiticaErrorResponse",
     "HabiticaException",
     "HabiticaGroupMembersResponse",
     "HabiticaLoginResponse",
+    "HabiticaQuestResponse",
     "HabiticaResponse",
     "HabiticaScoreResponse",
     "HabiticaSleepResponse",

habiticalib/const.py

@@ -1,6 +1,6 @@
 """Constants for Habiticalib."""
 
-__version__ = "0.2.0a1"
+__version__ = "0.2.0a2"
 
 DEFAULT_URL = "https://habitica.com/"
 ASSETS_URL = "https://habitica-assets.s3.amazonaws.com/mobileApp/images/"

habiticalib/lib.py

@@ -31,6 +31,7 @@ from .types import (
     Direction,
     HabiticaClass,
     HabiticaClassSystemResponse,
+    HabiticaContentResponse,
     HabiticaErrorResponse,
     HabiticaGroupMembersResponse,
     HabiticaLoginResponse,
@@ -263,14 +264,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.
@@ -458,7 +460,7 @@ class Habitica:
         Returns
         -------
         HabiticaTaskResponse
-            A response object containing the data for the deleted task.
+            A response containing an empty data object.
 
         Raises
         ------
@@ -562,7 +564,7 @@ class Habitica:
     async def get_content(
         self,
         language: Language | None = None,
-    ) -> HabiticaResponse:
+    ) -> HabiticaContentResponse:
         """
         Fetch game content from the Habitica API.
 
@@ -604,7 +606,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),
         )
 

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."""
@@ -1255,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.2.0a1.dist-info → habiticalib-0.2.0a2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: Habiticalib
-Version: 0.2.0a1
+Version: 0.2.0a2
 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.2.0a2.dist-info/RECORD

@@ -0,0 +1,11 @@
+habiticalib/__init__.py,sha256=qZEUcYA0WAyGbZAaRWU9GeqmsvvxLvnDEpBcMKkZMe0,1803
+habiticalib/const.py,sha256=tzHXqReY73QDyYNn66aN7TIjGVsr0Wd-RhmxOTEefsA,626
+habiticalib/exceptions.py,sha256=oVFCGbHkVn0UpIKIPZPzXfvzs9US4R05ebdEn6cOpqM,1350
+habiticalib/helpers.py,sha256=IRZLYWkDVLI0iVBgBMmvZ6L83KCUl-CnzGhUR_tP6Fg,4576
+habiticalib/lib.py,sha256=uPmuTRs5qRwE-RrHI0AFUsvEiZNT33XEW8uIgsgvaXQ,71339
+habiticalib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+habiticalib/types.py,sha256=zJq3jnZNUSU0p5XX_14PpGHmxmCeuf1F_YQjFpcoMLo,42341
+habiticalib-0.2.0a2.dist-info/METADATA,sha256=7-vUpy2rTPBslylAnDnjL5iESd328b9g0tFfeT0_4-8,4156
+habiticalib-0.2.0a2.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+habiticalib-0.2.0a2.dist-info/licenses/LICENSE,sha256=oIinIOSJ49l1iVIRI3XGXFWt6SF7a83kEFBAY8ORwNI,1084
+habiticalib-0.2.0a2.dist-info/RECORD,,

habiticalib-0.2.0a1.dist-info/RECORD

@@ -1,11 +0,0 @@
-habiticalib/__init__.py,sha256=QwR7xcAdEwZ1bAv02KlZCm4sw-8-xKlYOUAaB502mCA,1687
-habiticalib/const.py,sha256=hTmR0O6Bibw96tMCIy-Wsb_AC0K4AH1qiQVCJyJ_TAg,626
-habiticalib/exceptions.py,sha256=oVFCGbHkVn0UpIKIPZPzXfvzs9US4R05ebdEn6cOpqM,1350
-habiticalib/helpers.py,sha256=IRZLYWkDVLI0iVBgBMmvZ6L83KCUl-CnzGhUR_tP6Fg,4576
-habiticalib/lib.py,sha256=_HPEjoH1o0wbSM26mIbzGEbfvAery3O8XDMTmUZEY2U,71271
-habiticalib/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-habiticalib/types.py,sha256=ZmAkkDzXl9lj9fNWidlzjKkJ0CQStQVBi24u-3mgMPA,33907
-habiticalib-0.2.0a1.dist-info/METADATA,sha256=Yfdhp5dWPEylm1Ri2yU1zC2569oODmC6vSCERfG80mY,4156
-habiticalib-0.2.0a1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-habiticalib-0.2.0a1.dist-info/licenses/LICENSE,sha256=oIinIOSJ49l1iVIRI3XGXFWt6SF7a83kEFBAY8ORwNI,1084
-habiticalib-0.2.0a1.dist-info/RECORD,,