kavita_client.api.series.get_api_series_all_related

Module Contents

Functions

asyncio	Returns all related series against the passed series Id
asyncio_detailed	Returns all related series against the passed series Id
sync	Returns all related series against the passed series Id
sync_detailed	Returns all related series against the passed series Id

API

async kavita_client.api.series.get_api_series_all_related.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET) → kavita_client.models.related_series_dto.RelatedSeriesDto | None

Returns all related series against the passed series Id

Args:

series_id (int | Unset):

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:

RelatedSeriesDto

async kavita_client.api.series.get_api_series_all_related.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.related_series_dto.RelatedSeriesDto]

Returns all related series against the passed series Id

Args:

series_id (int | Unset):

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[RelatedSeriesDto]

kavita_client.api.series.get_api_series_all_related.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET) → kavita_client.models.related_series_dto.RelatedSeriesDto | None

Returns all related series against the passed series Id

Args:

series_id (int | Unset):

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:

RelatedSeriesDto

kavita_client.api.series.get_api_series_all_related.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.related_series_dto.RelatedSeriesDto]

Returns all related series against the passed series Id

Args:

series_id (int | Unset):

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[RelatedSeriesDto]