Skip to content

Types

Copyright (C) 2024 TheOnlyWayUp

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Typehints for the models in ./models.py. These types are used to specify what fields to request in API-Interfacing methods.

ConnectedServicesModelFieldsType #

Bases: TypedDict

Typehints for the Notifications model.

Source code in src/wattpad/model_types.py 
32
33
34
35
36
class ConnectedServicesModelFieldsType(TypedDict):
    """Typehints for the Notifications model."""

    facebook: NotRequired[bool]
    twitter: NotRequired[bool]

InboxModelFieldsType #

Bases: TypedDict

Typehints for the Inbox model.

Source code in src/wattpad/model_types.py 
19
20
21
22
23
class InboxModelFieldsType(TypedDict):
    """Typehints for the Inbox model."""

    unread: NotRequired[bool]
    total: NotRequired[bool]

LanguageModelFieldsType #

Bases: TypedDict

Typehints for the Language model.

Source code in src/wattpad/model_types.py 
87
88
89
90
91
class LanguageModelFieldsType(TypedDict):
    """Typehints for the Language model."""

    id: NotRequired[bool]
    name: NotRequired[bool]

ListModelFieldsType #

Bases: TypedDict

Typehints for the List model.

Source code in src/wattpad/model_types.py 
155
156
157
158
159
160
161
class ListModelFieldsType(TypedDict):
    """Typehints for the List model."""

    id: NotRequired[bool]
    name: NotRequired[bool]

    stories: NotRequired[StoryModelFieldsType | bool]

NotificationsModelFieldsType #

Bases: TypedDict

Typehints for the Notifications model.

Source code in src/wattpad/model_types.py 
26
27
28
29
class NotificationsModelFieldsType(TypedDict):
    """Typehints for the Notifications model."""

    unread: NotRequired[bool]

PartModelFieldsType #

Bases: TypedDict

Typehints for the Part model.

Source code in src/wattpad/model_types.py 
101
102
103
104
105
106
107
108
109
110
111
class PartModelFieldsType(TypedDict):
    """Typehints for the Part model."""

    id: NotRequired[bool]
    title: NotRequired[bool]
    url: NotRequired[bool]
    modifyDate: NotRequired[bool]
    createDate: NotRequired[bool]
    commentCount: NotRequired[bool]
    voteCount: NotRequired[bool]
    readCount: NotRequired[bool]

PublishedModelFieldsType #

Bases: TypedDict

Typehints for the Published model (for the firstPublishedPart and lastPublishedPart fields).

Source code in src/wattpad/model_types.py 
94
95
96
97
98
class PublishedModelFieldsType(TypedDict):
    """Typehints for the Published model (for the firstPublishedPart and lastPublishedPart fields)."""

    id: NotRequired[bool]
    createDate: NotRequired[bool]

StoryModelFieldsType #

Bases: TypedDict

Typehints for the Story model.

Source code in src/wattpad/model_types.py 
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
class StoryModelFieldsType(TypedDict):
    """Typehints for the Story model."""

    id: NotRequired[bool]
    title: NotRequired[bool]
    createDate: NotRequired[bool]
    modifyDate: NotRequired[bool]
    voteCount: NotRequired[bool]
    readCount: NotRequired[bool]
    commentCount: NotRequired[bool]
    description: NotRequired[bool]
    completed: NotRequired[bool]
    tags: NotRequired[bool]
    rating: NotRequired[bool]
    mature: NotRequired[bool]
    url: NotRequired[bool]
    isPaywalled: NotRequired[bool]
    cover: NotRequired[bool]
    cover_timestamp: NotRequired[bool]
    categories: NotRequired[bool]
    copyright: NotRequired[bool]
    firstPartId: NotRequired[bool]
    numParts: NotRequired[bool]
    deleted: NotRequired[bool]

    parts: NotRequired[PartModelFieldsType | bool]
    tagRankings: NotRequired[TagRankingModelFieldsType | bool]
    firstPublishedPart: NotRequired[PublishedModelFieldsType | bool]
    lastPublishedPart: NotRequired[PublishedModelFieldsType | bool]
    language: NotRequired[LanguageModelFieldsType | bool]
    user: NotRequired[UserModelFieldsType | bool]

TagRankingModelFieldsType #

Bases: TypedDict

Typehints for the TagRankings model.

Source code in src/wattpad/model_types.py 
114
115
116
117
118
119
class TagRankingModelFieldsType(TypedDict):
    """Typehints for the TagRankings model."""

    name: NotRequired[bool]
    rank: NotRequired[bool]
    total: NotRequired[bool]

UserModelFieldsType #

Bases: TypedDict

Typehints for the User model.

Source code in src/wattpad/model_types.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
class UserModelFieldsType(TypedDict):
    """Typehints for the User model."""

    username: NotRequired[bool]
    avatar: NotRequired[bool]
    isPrivate: NotRequired[bool]
    backgroundUrl: NotRequired[bool]
    follower: NotRequired[bool]
    following: NotRequired[bool]
    name: NotRequired[bool]
    description: NotRequired[bool]
    status: NotRequired[bool]
    gender: NotRequired[bool]
    genderCode: NotRequired[bool]
    language: NotRequired[bool]
    locale: NotRequired[bool]
    createDate: NotRequired[bool]
    modifyDate: NotRequired[bool]
    location: NotRequired[bool]
    verified: NotRequired[bool]
    ambassador: NotRequired[bool]
    facebook: NotRequired[bool]
    twitter: NotRequired[bool]
    website: NotRequired[bool]
    lulu: NotRequired[bool]
    smashwords: NotRequired[bool]
    bubok: NotRequired[bool]
    votesReceived: NotRequired[bool]
    numStoriesPublished: NotRequired[bool]
    numFollowing: NotRequired[bool]
    numFollowers: NotRequired[bool]
    numMessages: NotRequired[bool]
    numLists: NotRequired[bool]
    verified_email: NotRequired[bool]
    preferred_categories: NotRequired[bool]
    allowCrawler: NotRequired[bool]
    deeplink: NotRequired[bool]
    isMuted: NotRequired[bool]
    birthdate: NotRequired[bool]
    age: NotRequired[int]
    email: NotRequired[bool]
    has_password: NotRequired[bool]

    inbox: NotRequired[InboxModelFieldsType | bool]
    notifications: NotRequired[NotificationsModelFieldsType | bool]
    connectedServices: NotRequired[ConnectedServicesModelFieldsType | bool]