Collection

`BaseCollection`

A data model representing a collection item in the list view.

ATTRIBUTE	DESCRIPTION
`id`	The unique identifier of the collection item. TYPE: `int`
`user`	The user who owns this collection item. TYPE: `User`
`issue`	The issue associated with this collection item. TYPE: `GenericIssue`
`quantity`	Number of copies owned. TYPE: `int`
`book_format`	Format of the comic (print, digital, or both). TYPE: `BookFormat`
`grade`	Comic book grade (CGC scale). TYPE: `Grade \| None`
`grading_company`	Professional grading company. TYPE: `GradingCompany \| None`
`purchase_date`	Date when the issue was purchased. TYPE: `date \| None`
`is_read`	Whether the issue has been read. TYPE: `bool \| None`
`read_dates`	List of read date entries for this issue. TYPE: `Annotated[list[ReadDate], Field(default_factory=list)]`
`read_count`	Number of times this issue has been read. TYPE: `int`
`rating`	Star rating (1-5) for this issue. TYPE: `Rating \| None`
`modified`	The date and time when the collection item was last modified. TYPE: `datetime`

Bases: str, Enum

Enumeration of book formats.

ATTRIBUTE	DESCRIPTION
`PRINT`	Physical printed comic book
`DIGITAL`	Digital/electronic comic book
`BOTH`	Both print and digital formats

A data model representing a collection item in detailed view.

ATTRIBUTE	DESCRIPTION
`purchase_price`	Price paid for this issue. TYPE: `Decimal \| None`
`purchase_store`	Store or vendor where purchased. TYPE: `str \| None`
`storage_location`	Physical location where the collection is stored. TYPE: `str \| None`
`notes`	Additional notes about this collection item. TYPE: `str \| None`
`date_read`	Date and time when the issue was last read. TYPE: `datetime \| None`
`resource_url`	URL of the collection resource. TYPE: `HttpUrl`
`created_on`	The date and time when the collection was created. TYPE: `datetime`

A data model representing statistics for a specific book format.

ATTRIBUTE	DESCRIPTION
`book_format`	Format of the comic (print, digital, or both). TYPE: `BookFormat \| None`
`count`	Number of items in this format. TYPE: `int \| None`

A data model representing statistics about a user's collection.

ATTRIBUTE	DESCRIPTION
`total_items`	Total number of collection items. TYPE: `int \| None`
`total_quantity`	Total quantity of all items. TYPE: `int \| None`
`total_value`	Total value of the collection. TYPE: `str \| None`
`read_count`	Number of items that have been read. TYPE: `int \| None`
`unread_count`	Number of items that have not been read. TYPE: `int \| None`
`by_format`	Statistics broken down by book format. TYPE: `Annotated[list[CollectionFormatStat], Field(default_factory=list)]`

Bases: float, Enum

Enumeration of comic book grades using the CGC scale.

Bases: str, Enum

Enumeration of professional grading companies.

ATTRIBUTE	DESCRIPTION
`CGC`	Certified Guaranty Company
`CBCS`	Comic Book Certification Service
`PGX`	Professional Grading Experts

Bases: int, Enum

Enumeration of star ratings for comic books.

A data model representing a read date entry.

ATTRIBUTE	DESCRIPTION
`id`	The unique identifier of the read date entry. TYPE: `int`
`read_date`	Date and time when the issue was read. TYPE: `datetime`
`created_on`	The date and time when the read date entry was created. TYPE: `datetime`