kavita_client.api.series.get_api_series_related

Module Contents

Functions

asyncio	Fetches the related series for a given series
asyncio_detailed	Fetches the related series for a given series
sync	Fetches the related series for a given series
sync_detailed	Fetches the related series for a given series

API

async kavita_client.api.series.get_api_series_related.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET, relation: kavita_client.models.relation_kind.RelationKind | kavita_client.types.Unset = UNSET) → list[kavita_client.models.series_dto.SeriesDto] | None

Fetches the related series for a given series

Args:

series_id (int | Unset): relation (RelationKind | Unset): Members:

• 1 — Prequel

• 2 — Sequel

• 3 — Spin Off (SpinOff)

• 4 — Adaptation

• 5 — Side Story (SideStory)

• 6 — Character

• 7 — Contains

• 8 — Other

• 9 — Alternative Setting (AlternativeSetting)

• 10 — Alternative Version (AlternativeVersion)

• 11 — Doujinshi

• 12 — Parent

• 13 — Edition

• 14 — Annual

• 16 — Cameo

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

list[SeriesDto]

async kavita_client.api.series.get_api_series_related.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET, relation: kavita_client.models.relation_kind.RelationKind | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.series_dto.SeriesDto]]

Fetches the related series for a given series

Args:

series_id (int | Unset): relation (RelationKind | Unset): Members:

• 1 — Prequel

• 2 — Sequel

• 3 — Spin Off (SpinOff)

• 4 — Adaptation

• 5 — Side Story (SideStory)

• 6 — Character

• 7 — Contains

• 8 — Other

• 9 — Alternative Setting (AlternativeSetting)

• 10 — Alternative Version (AlternativeVersion)

• 11 — Doujinshi

• 12 — Parent

• 13 — Edition

• 14 — Annual

• 16 — Cameo

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[list[SeriesDto]]

kavita_client.api.series.get_api_series_related.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET, relation: kavita_client.models.relation_kind.RelationKind | kavita_client.types.Unset = UNSET) → list[kavita_client.models.series_dto.SeriesDto] | None

Fetches the related series for a given series

Args:

series_id (int | Unset): relation (RelationKind | Unset): Members:

• 1 — Prequel

• 2 — Sequel

• 3 — Spin Off (SpinOff)

• 4 — Adaptation

• 5 — Side Story (SideStory)

• 6 — Character

• 7 — Contains

• 8 — Other

• 9 — Alternative Setting (AlternativeSetting)

• 10 — Alternative Version (AlternativeVersion)

• 11 — Doujinshi

• 12 — Parent

• 13 — Edition

• 14 — Annual

• 16 — Cameo

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

list[SeriesDto]

kavita_client.api.series.get_api_series_related.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET, relation: kavita_client.models.relation_kind.RelationKind | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.series_dto.SeriesDto]]

Fetches the related series for a given series

Args:

series_id (int | Unset): relation (RelationKind | Unset): Members:

• 1 — Prequel

• 2 — Sequel

• 3 — Spin Off (SpinOff)

• 4 — Adaptation

• 5 — Side Story (SideStory)

• 6 — Character

• 7 — Contains

• 8 — Other

• 9 — Alternative Setting (AlternativeSetting)

• 10 — Alternative Version (AlternativeVersion)

• 11 — Doujinshi

• 12 — Parent

• 13 — Edition

• 14 — Annual

• 16 — Cameo

Raises:

errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. httpx.TimeoutException: If the request takes longer than Client.timeout.

Returns:

Response[list[SeriesDto]]