kavita_client.api.series.post_api_series_on_deck

Module Contents

Functions

asyncio	Fetches series that are on deck aka have progress on them.
asyncio_detailed	Fetches series that are on deck aka have progress on them.
sync	Fetches series that are on deck aka have progress on them.
sync_detailed	Fetches series that are on deck aka have progress on them.

API

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

Fetches series that are on deck aka have progress on them.

Args:

page_number (int | Unset): page_size (int | Unset): library_id (int | Unset): Default: 0.

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.post_api_series_on_deck.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET, library_id: int | kavita_client.types.Unset = 0) → kavita_client.types.Response[list[kavita_client.models.series_dto.SeriesDto]]

Fetches series that are on deck aka have progress on them.

Args:

page_number (int | Unset): page_size (int | Unset): library_id (int | Unset): Default: 0.

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.post_api_series_on_deck.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET, library_id: int | kavita_client.types.Unset = 0) → list[kavita_client.models.series_dto.SeriesDto] | None

Fetches series that are on deck aka have progress on them.

Args:

page_number (int | Unset): page_size (int | Unset): library_id (int | Unset): Default: 0.

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.post_api_series_on_deck.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET, library_id: int | kavita_client.types.Unset = 0) → kavita_client.types.Response[list[kavita_client.models.series_dto.SeriesDto]]

Fetches series that are on deck aka have progress on them.

Args:

page_number (int | Unset): page_size (int | Unset): library_id (int | Unset): Default: 0.

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