Reading List

AttributionSource

Bases: str, Enum

Enumeration of attribution sources for reading lists.

Values:

Text Only

CBRO: Comic Book Reading Orders
CMRO: Complete Marvel Reading Orders
CBH: Comic Book Herald
CBT: Comic Book Treasury
MG: Marvel Guides
HTLC: How To Love Comics
LOCG: League of ComicGeeks
OTHER: Other sources

ListType

Bases: str, Enum

Enumeration of reading list types.

Values:

Text Only

EVENT: Event
STORY: Story
CHARACTERS: Characters
TEAMS: Teams
MASTER: Master

ReadingListIssue

Bases: BaseModel

A data model representing an issue in a reading list (without image and cover_hash).

ATTRIBUTE	DESCRIPTION
id	The unique identifier of the issue. TYPE: int
series	The series associated with the issue. TYPE: BasicSeries
number	The number of the issue. TYPE: str
cover_date	The cover date of the issue. TYPE: date
store_date	The store date of the issue. TYPE: date
cv_id	The Comic Vine ID of the issue. TYPE: int
gcd_id	The Grand Comics Database ID of the issue. TYPE: int
modified	The date and time when the issue was last modified. TYPE: datetime

ReadingListItem

Bases: BaseModel

A data model representing an item in a reading list.

ATTRIBUTE	DESCRIPTION
id	The unique identifier of the reading list item. TYPE: int
issue	The issue associated with this reading list item. TYPE: ReadingListIssue
order	Position of this issue in the reading list. TYPE: int
issue_type	The type of the issue. TYPE: str

ReadingListList

Bases: BaseModel

A data model representing a reading list in list view.

ATTRIBUTE	DESCRIPTION
id	The unique identifier of the reading list. TYPE: int
name	The name of the reading list. TYPE: str
slug	The slug for the reading list. TYPE: str
user	The user who owns the reading list. TYPE: User
list_type	The type of the reading list. TYPE: str
is_private	Whether this list is private (only visible to the owner). TYPE: bool
attribution_source	Source where this reading list information was obtained. TYPE: AttributionSource
average_rating	The average rating of the reading list. TYPE: float
rating_count	The number of ratings for the reading list. TYPE: int
modified	The date and time when the reading list was last modified. TYPE: datetime

Functions

convert_empty_string_to_none(_cls, v: str | None) -> str | None classmethod

Convert empty strings to None for attribution_source.

The API may return an empty string when there is no attribution source, but we want to store this as None internally.

PARAMETER	DESCRIPTION
v	The value to validate TYPE: str | None

RETURNS	DESCRIPTION
str | None	None if the value is an empty string, otherwise the original value

ReadingListRead

Bases: BaseModel

A data model representing a reading list in detailed view.

ATTRIBUTE	DESCRIPTION
id	The unique identifier of the reading list. TYPE: int
user	The user who owns the reading list. TYPE: User
name	The name of the reading list. TYPE: str
slug	The slug for the reading list. TYPE: str
desc	The description of the reading list. TYPE: str
image	The image for the reading list. TYPE: HttpUrl
list_type	The type of the reading list. TYPE: str
is_private	Whether this list is private (only visible to the owner). TYPE: bool
attribution_source	Source where this reading list information was obtained. TYPE: str
attribution_url	URL of the specific page where this reading list was obtained. TYPE: HttpUrl
average_rating	The average rating of the reading list. TYPE: float
rating_count	The number of ratings for the reading list. TYPE: int
items_url	URL to the paginated items endpoint. TYPE: str
resource_url	URL of the reading list resource. TYPE: str
modified	The date and time when the reading list was last modified. TYPE: datetime

Functions

convert_empty_string_to_none(_cls, v: str | None) -> str | None classmethod

Convert empty strings to None for attribution_url.

The API may return an empty string when there is no attribution URL, but we want to store this as None internally.

PARAMETER	DESCRIPTION
v	The value to validate TYPE: str | None

RETURNS	DESCRIPTION
str | None	None if the value is an empty string, otherwise the original value