kavita_client.api.series.get_api_series_series_by_collection

Module Contents

Functions

asyncio	Returns all Series grouped by the passed Collection Id with Pagination.
asyncio_detailed	Returns all Series grouped by the passed Collection Id with Pagination.
sync	Returns all Series grouped by the passed Collection Id with Pagination.
sync_detailed	Returns all Series grouped by the passed Collection Id with Pagination.

API

async kavita_client.api.series.get_api_series_series_by_collection.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, collection_id: int | kavita_client.types.Unset = UNSET, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET) → list[kavita_client.models.series_dto.SeriesDto] | None

Returns all Series grouped by the passed Collection Id with Pagination.

Args:

collection_id (int | Unset): page_number (int | Unset): page_size (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:

list[SeriesDto]

async kavita_client.api.series.get_api_series_series_by_collection.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, collection_id: int | kavita_client.types.Unset = UNSET, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.series_dto.SeriesDto]]

Returns all Series grouped by the passed Collection Id with Pagination.

Args:

collection_id (int | Unset): page_number (int | Unset): page_size (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[list[SeriesDto]]

kavita_client.api.series.get_api_series_series_by_collection.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, collection_id: int | kavita_client.types.Unset = UNSET, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET) → list[kavita_client.models.series_dto.SeriesDto] | None

Returns all Series grouped by the passed Collection Id with Pagination.

Args:

collection_id (int | Unset): page_number (int | Unset): page_size (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:

list[SeriesDto]

kavita_client.api.series.get_api_series_series_by_collection.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, collection_id: int | kavita_client.types.Unset = UNSET, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.series_dto.SeriesDto]]

Returns all Series grouped by the passed Collection Id with Pagination.

Args:

collection_id (int | Unset): page_number (int | Unset): page_size (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[list[SeriesDto]]