Skip to content

Series

AssociatedSeries

Bases: BaseModel

A data model representing an associated series.

ATTRIBUTE DESCRIPTION
id

The unique identifier of the associated series.

TYPE: int

name

The name of the associated series.

TYPE: Annotated[str, Field(alias=series)]

BaseSeries

Bases: BaseModel

A data model representing a base series.

ATTRIBUTE DESCRIPTION
id

The unique identifier of the series.

TYPE: int

year_began

The year the series began.

TYPE: int

year_end

The year the series ended.

TYPE: int | None

volume

The volume number of the series.

TYPE: int

issue_count

The number of issues in the series.

TYPE: int

modified

The datetime when the series was last modified.

TYPE: datetime

CommonSeries

Bases: BaseSeries

A data model representing a common series that extends BaseSeries.

ATTRIBUTE DESCRIPTION
name

The display name of the series.

TYPE: Annotated[str, Field(alias=series)]

GenericSeries

Bases: BaseModel

A data model representing a generic series.

ATTRIBUTE DESCRIPTION
name

The name of the series.

TYPE: str

volume

The volume of the series.

TYPE: int

year_began

The year the series began.

TYPE: int

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 | None

publisher

TYPE: GenericResource

series_type

TYPE: GenericResource

total_issues

TYPE: int

owned_issues

TYPE: int

missing_count

TYPE: int

completion_percentage

TYPE: Decimal

Series

Bases: BaseSeries

A data model representing a series that extends BaseSeries.

ATTRIBUTE DESCRIPTION
name

The name of the series.

TYPE: str

sort_name

The name used for sorting the series.

TYPE: str

series_type

The type of the series.

TYPE: GenericResource

status

The status of the series.

TYPE: str

publisher

The publisher of the series.

TYPE: GenericResource

imprint

The imprint of the series or None.

TYPE: GenericResource | None

desc

The description of the series.

TYPE: str | None

genres

The genres associated with the series.

TYPE: Annotated[list[GenericResource], Field(default_factory=list)]

associated

The associated series.

TYPE: Annotated[list[AssociatedSeries], Field(default_factory=list)]

cv_id

The Comic Vine ID of the series.

TYPE: int | None

gcd_id

The Grand Comics Database ID of the series.

TYPE: int | None

resource_url

The URL of the series resource.

TYPE: HttpUrl

SeriesInfo

Bases: GenericSeries

A data model representing generic series info extending the GenericSeries model.

ATTRIBUTE DESCRIPTION
id

The unique identifier of the series.

TYPE: int

sort_name

The name used for sorting the series.

TYPE: str

series_type

The type of the series.

TYPE: GenericResource

genres

The genres associated with the series.

TYPE: Annotated[list[GenericResource], Field(default_factory=list)]