kavita_client.api.download.get_api_download_volume

Module Contents

Functions

asyncio_detailed	Downloads all chapters within a volume. If the chapters are multiple zips, they will all be zipped up.
sync_detailed	Downloads all chapters within a volume. If the chapters are multiple zips, they will all be zipped up.

API

async kavita_client.api.download.get_api_download_volume.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, volume_id: int | kavita_client.types.Unset = UNSET, correlation_id: str | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[Any]

Downloads all chapters within a volume. If the chapters are multiple zips, they will all be zipped up.

Args:

volume_id (int | Unset): correlation_id (str | 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[Any]

kavita_client.api.download.get_api_download_volume.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, volume_id: int | kavita_client.types.Unset = UNSET, correlation_id: str | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[Any]

Downloads all chapters within a volume. If the chapters are multiple zips, they will all be zipped up.

Args:

volume_id (int | Unset): correlation_id (str | 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[Any]