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

habiticalib/types.py

@@ -4,13 +4,13 @@
 from __future__ import annotations
 
 from dataclasses import dataclass, field
+import datetime as dt
 from datetime import UTC, datetime
 from enum import Enum, StrEnum
-from typing import Any
+from typing import Any, NotRequired, TypedDict
 from uuid import UUID  # noqa: TCH003
 
 from mashumaro import field_options
-from mashumaro.config import BaseConfig
 from mashumaro.mixins.orjson import DataClassORJSONMixin
 
 
@@ -61,6 +61,7 @@ class LoginData:
     apiToken: str
     newUser: bool
     username: str
+    passwordResetCode: str | None = None
 
 
 @dataclass(kw_only=True)
@@ -74,27 +75,27 @@ class HabiticaLoginResponse(HabiticaResponse):
 class LocalAuth:
     """Auth local data."""
 
-    email: str
-    username: str
-    lowerCaseUsername: str
-    has_password: bool
+    email: str | None = None
+    username: str | None = None
+    lowerCaseUsername: str | None = None
+    has_password: bool | None = None
 
 
 @dataclass(kw_only=True)
 class LocalTimestamps:
     """Timestamps local data."""
 
-    created: datetime
-    loggedin: datetime
-    updated: datetime
+    created: datetime | None = None
+    loggedin: datetime | None = None
+    updated: datetime | None = None
 
 
 @dataclass(kw_only=True)
 class AuthUser:
     """User auth data."""
 
-    local: LocalAuth | None = None
-    timestamps: LocalTimestamps | None = None
+    local: LocalAuth = field(default_factory=LocalAuth)
+    timestamps: LocalTimestamps = field(default_factory=LocalTimestamps)
     facebook: dict | None = None
     google: dict | None = None
     apple: dict | None = None
@@ -590,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)
@@ -628,6 +629,15 @@ class TrainingStats:
     Int: int | None = field(default=None, metadata=field_options(alias="int"))
 
 
+class HabiticaClass(StrEnum):
+    """Habitica's player classes."""
+
+    WARRIOR = "warrior"
+    ROGUE = "rogue"
+    MAGE = "wizard"
+    HEALER = "healer"
+
+
 @dataclass(kw_only=True)
 class StatsUser:
     """Stats user data."""
@@ -639,7 +649,9 @@ class StatsUser:
     exp: int | None = None
     gp: float | None = None
     lvl: int | None = None
-    Class: str = field(default="warrior", metadata=field_options(alias="class"))
+    Class: HabiticaClass | None = field(
+        default=None, metadata=field_options(alias="class")
+    )
     points: int | None = None
     Str: int | None = field(default=None, metadata=field_options(alias="str"))
     con: int | None = None
@@ -674,10 +686,10 @@ class InboxUser:
 class TasksOrderUser:
     """TasksOrder user data."""
 
-    habits: list[str] = field(default_factory=list)
-    dailys: list[str] = field(default_factory=list)
-    todos: list[str] = field(default_factory=list)
-    rewards: list[str] = field(default_factory=list)
+    habits: list[UUID] = field(default_factory=list)
+    dailys: list[UUID] = field(default_factory=list)
+    todos: list[UUID] = field(default_factory=list)
+    rewards: list[UUID] = field(default_factory=list)
 
 
 @dataclass(kw_only=True)
@@ -717,7 +729,7 @@ class UserData:
 
     id: UUID | None = None
     preferences: PreferencesUser = field(default_factory=PreferencesUser)
-    flags: FlagsUser | None = None
+    flags: FlagsUser = field(default_factory=FlagsUser)
     auth: AuthUser = field(default_factory=AuthUser)
     achievements: AchievementsUser = field(default_factory=AchievementsUser)
     backer: BackerUser = field(default_factory=BackerUser)
@@ -746,8 +758,8 @@ class UserData:
     balance: float | None = None
     lastCron: datetime | None = None
     needsCron: bool | None = None
-    challenges: list[str] = field(default_factory=list)
-    guilds: list[str] = field(default_factory=list)
+    challenges: list[UUID] = field(default_factory=list)
+    guilds: list[UUID] = field(default_factory=list)
     newMessages: dict[str, bool] = field(default_factory=dict)
 
 
@@ -758,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."""
@@ -850,38 +869,31 @@ class Frequency(StrEnum):
     YEARLY = "yearly"
 
 
-@dataclass(kw_only=True)
-class Task(DataClassORJSONMixin):
+class Task(TypedDict("Task", {"type": NotRequired[TaskType]}), total=True):
     """Representation of a task."""
 
-    class Config(BaseConfig):
-        """Config."""
-
-        omit_none = True
-
-    text: str | None = None
-    attribute: Attributes | None = None
-    alias: str | None = None
-    notes: str | None = None
-    tags: list[UUID] | None = None
-    collapseChecklist: bool | None = None
-    date: datetime | None = None
-    priority: TaskPriority | None = None
-    reminders: list[Reminders] | None = None
-    checklist: list[str] | None = None
-    Type: TaskType | None = field(default=None, metadata=field_options(alias="type"))
-    up: bool | None = None
-    down: bool | None = None
-    counterUp: int | None = None
-    counterDown: int | None = None
-    startDate: datetime | None = None
-    frequency: Frequency | None = None
-    everyX: int | None = None
-    repeat: Repeat | None = None
-    daysOfMonth: list[int] | None = None
-    weeksOfMonth: list[int] | None = None
-    completed: bool | None = None
-    streak: int | None = None
+    text: NotRequired[str]
+    attribute: NotRequired[Attributes]
+    alias: NotRequired[str]
+    notes: NotRequired[str]
+    tags: NotRequired[list[UUID]]
+    collapseChecklist: NotRequired[bool]
+    date: NotRequired[datetime | dt.date | None]
+    priority: NotRequired[TaskPriority]
+    reminders: NotRequired[list[Reminders]]
+    checklist: NotRequired[list[str]]
+    up: NotRequired[bool]
+    down: NotRequired[bool]
+    counterUp: NotRequired[int]
+    counterDown: NotRequired[int]
+    startDate: NotRequired[datetime | dt.date]
+    frequency: NotRequired[Frequency]
+    everyX: NotRequired[int]
+    repeat: NotRequired[Repeat]
+    daysOfMonth: NotRequired[list[int]]
+    weeksOfMonth: NotRequired[list[int]]
+    completed: NotRequired[bool]
+    streak: NotRequired[int]
 
 
 @dataclass(kw_only=True)
@@ -979,7 +991,7 @@ class StatsUserStyles:
     """Stats user styles data."""
 
     buffs: BuffsUserStyles = field(default_factory=BuffsUserStyles)
-    Class: str = field(default="warrior", metadata=field_options(alias="class"))
+    Class: HabiticaClass = field(default=HabiticaClass.WARRIOR)
 
 
 @dataclass(kw_only=True)
@@ -1052,7 +1064,7 @@ class DropTmpScore:
     canDrop: bool | None = None
     value: int | None = None
     key: str | None = None
-    type: str | None = None
+    Type: str | None = field(default=None, metadata=field_options(alias="type"))
     dialog: str | None = None
 
 
@@ -1064,12 +1076,21 @@ class TmpScore:
     drop: DropTmpScore = field(default_factory=DropTmpScore)
 
 
+@dataclass
+class ScoreData(StatsUser):
+    """Scora data."""
+
+    delta: float | None = None
+    tmp: TmpScore = field(
+        default_factory=TmpScore, metadata=field_options(alias="_tmp")
+    )
+
+
 @dataclass(kw_only=True)
-class HabiticaScoreResponse(StatsUser, DataClassORJSONMixin):
+class HabiticaScoreResponse(HabiticaResponse, DataClassORJSONMixin):
     """Representation of a score response."""
 
-    delta: float | None = None
-    _tmp: TmpScore = field(default_factory=TmpScore)
+    data: ScoreData
 
 
 @dataclass(kw_only=True)
@@ -1086,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."""
@@ -1107,7 +1147,14 @@ class HabiticaClassSystemResponse(HabiticaResponse, DataClassORJSONMixin):
 class HabiticaTaskOrderResponse(HabiticaResponse):
     """Representation of a reorder task response."""
 
-    data: TasksOrderUser = field(default_factory=TasksOrderUser)
+    data: list[UUID] = field(default_factory=list)
+
+
+@dataclass
+class HabiticaSleepResponse(HabiticaResponse):
+    """Representation of a sleep response."""
+
+    data: bool
 
 
 class TaskFilter(StrEnum):
@@ -1166,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"
@@ -1187,15 +1234,6 @@ class Skill(StrEnum):
     PETAL_FREE_POTION = "petalFreePotion"
 
 
-class Class(StrEnum):
-    """Habitica's player classes."""
-
-    WARRIOR = "warrior"
-    ROGUE = "rogue"
-    MAGE = "mage"
-    HEALER = "healer"
-
-
 class Direction(StrEnum):
     """Direction to score a task."""
 
@@ -1210,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