Collection

`BookFormat`

Bases: str, Enum

Enumeration of book formats.

Values:

Text Only

PRINT: Physical printed comic book
DIGITAL: Digital/electronic comic book
BOTH: Both print and digital formats

`CollectionFormatStat`

Bases: BaseModel

A data model representing statistics for a specific book format.

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

`CollectionIssue`

Bases: BaseModel

A data model representing an issue in a collection (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`
`modified`	The date and time when the issue was last modified. TYPE: `datetime`

`CollectionList`

Bases: BaseModel

A data model representing a collection item in 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: `CollectionIssue`
`quantity`	Number of copies owned. TYPE: `int`
`book_format`	Format of the comic (print, digital, or both). TYPE: `str`
`grade`	Comic book grade (CGC scale). TYPE: `float`
`grading_company`	Professional grading company. TYPE: `str`
`purchase_date`	Date when the issue was purchased. TYPE: `date`
`is_read`	Whether the issue has been read. TYPE: `bool`
`read_dates`	List of read date entries for this issue. TYPE: `list[ReadDate]`
`read_count`	Number of times this issue has been read. TYPE: `int`
`rating`	Star rating (1-5) for this issue. TYPE: `int`
`modified`	The date and time when the collection item was last modified. TYPE: `datetime`

`CollectionRead`

Bases: BaseModel

A data model representing a collection item in detailed 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: `CollectionIssue`
`quantity`	Number of copies owned. TYPE: `int`
`book_format`	Format of the comic (print, digital, or both). TYPE: `str`
`grade`	Comic book grade (CGC scale). TYPE: `float`
`grading_company`	Professional grading company. TYPE: `str`
`purchase_date`	Date when the issue was purchased. TYPE: `date`
`purchase_price`	Price paid for this issue. TYPE: `Decimal`
`purchase_store`	Store or vendor where purchased. TYPE: `str`
`storage_location`	Physical location where the issue is stored. TYPE: `str`
`notes`	Additional notes about this collection item. TYPE: `str`
`is_read`	Whether the issue has been read. TYPE: `bool`
`date_read`	Date and time when the issue was last read. TYPE: `datetime`
`read_dates`	List of read date entries for this issue. TYPE: `list[ReadDate]`
`read_count`	Number of times this issue has been read. TYPE: `int`
`rating`	Star rating (1-5) for this issue. TYPE: `int`
`resource_url`	URL of the collection item resource. TYPE: `str`
`created_on`	The date and time when the collection item was created. TYPE: `datetime`
`modified`	The date and time when the collection item was last modified. TYPE: `datetime`

`CollectionStats`

Bases: BaseModel

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

ATTRIBUTE	DESCRIPTION
`total_items`	Total number of collection items. TYPE: `int`
`total_quantity`	Total quantity of all items. TYPE: `int`
`total_value`	Total value of the collection. TYPE: `str`
`read_count`	Number of items that have been read. TYPE: `int`
`unread_count`	Number of items that have not been read. TYPE: `int`
`by_format`	Statistics broken down by book format. TYPE: `list[CollectionFormatStat]`

`Grade`

Bases: float, Enum

Enumeration of comic book grades using the CGC scale.

Values:

Text Only

GEM_MINT: 10.0 (Gem Mint)
MINT: 9.9 (Mint)
NM_M: 9.8 (NM/M - Near Mint/Mint)
NM_PLUS: 9.6 (NM+ - Near Mint+)
NM: 9.4 (NM - Near Mint)
NM_MINUS: 9.2 (NM- - Near Mint-)
VF_NM: 9.0 (VF/NM - Very Fine/Near Mint)
VF_PLUS: 8.5 (VF+ - Very Fine+)
VF: 8.0 (VF - Very Fine)
VF_MINUS: 7.5 (VF- - Very Fine-)
FN_VF: 7.0 (FN/VF - Fine/Very Fine)
FN_PLUS: 6.5 (FN+ - Fine+)
FN: 6.0 (FN - Fine)
FN_MINUS: 5.5 (FN- - Fine-)
VG_FN: 5.0 (VG/FN - Very Good/Fine)
VG_PLUS: 4.5 (VG+ - Very Good+)
VG: 4.0 (VG - Very Good)
VG_MINUS: 3.5 (VG- - Very Good-)
GD_VG: 3.0 (GD/VG - Good/Very Good)
GD_PLUS: 2.5 (GD+ - Good+)
GD: 2.0 (GD - Good)
GD_MINUS: 1.8 (GD- - Good-)
FR_GD: 1.5 (FR/GD - Fair/Good)
FR: 1.0 (FR - Fair)
PR: 0.5 (PR - Poor)

`GradingCompany`

Bases: str, Enum

Enumeration of professional grading companies.

Values:

Text Only

CGC: CGC (Certified Guaranty Company)
CBCS: CBCS (Comic Book Certification Service)
PGX: PGX (Professional Grading Experts)

`MissingIssue`

Bases: BaseModel

A data model representing a missing issue in a series.

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`

`MissingSeries`

Bases: BaseModel

A data model representing a series with missing issues.

ATTRIBUTE	DESCRIPTION
`id`	The unique identifier of the series. TYPE: `int`
`name`	The name of the series. TYPE: `str`
`sort_name`	The sort name of the series. TYPE: `str`
`year_began`	The year the series began. TYPE: `int`
`year_end`	The year the series ended. TYPE: `int`
`publisher`	The publisher of the series. TYPE: `GenericItem`
`series_type`	The type of the series. TYPE: `GenericItem`
`total_issues`	Total number of issues in the series. TYPE: `int`
`owned_issues`	Number of issues owned in the collection. TYPE: `int`
`missing_count`	Number of issues missing from the collection. TYPE: `int`
`completion_percentage`	Percentage of the series that is owned. TYPE: `float`

`Rating`

Bases: int, Enum

Enumeration of star ratings (1-5) for issues.

Values:

Text Only

ONE: 1 star
TWO: 2 stars
THREE: 3 stars
FOUR: 4 stars
FIVE: 5 stars

`ScrobbleRequest`

Bases: BaseModel

A data model representing a request to mark an issue as read.

This is used to "scrobble" an issue, marking it as read and optionally providing a rating. If the issue is not in the collection, it will be automatically added.

ATTRIBUTE	DESCRIPTION
`issue_id`	The unique identifier of the issue to mark as read. TYPE: `int`
`date_read`	Date and time when the issue was read. If not provided, the current date/time will be used. TYPE: `datetime`
`rating`	Star rating (1-5) for this issue. TYPE: `int`

`ScrobbleResponse`

Bases: BaseModel

A data model representing the response from a scrobble operation.

ATTRIBUTE	DESCRIPTION
`id`	The unique identifier of the collection item. TYPE: `int`
`issue`	The issue that was scrobbled. TYPE: `CollectionIssue`
`is_read`	Whether the issue has been read (always True after scrobbling). TYPE: `bool`
`date_read`	Date and time when the issue was read. TYPE: `datetime`
`rating`	Star rating (1-5) for this issue. TYPE: `int`
`created`	Whether a new collection item was created (True) or an existing one was updated (False). TYPE: `bool`
`modified`	The date and time when the collection item was last modified. TYPE: `datetime`