kavita_client.api.reader.get_api_reader_volume_bookmarks

Module Contents

Functions

asyncio	Returns all bookmarked pages for a given volume
asyncio_detailed	Returns all bookmarked pages for a given volume
sync	Returns all bookmarked pages for a given volume
sync_detailed	Returns all bookmarked pages for a given volume

API

async kavita_client.api.reader.get_api_reader_volume_bookmarks.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, volume_id: int | kavita_client.types.Unset = UNSET) → list[kavita_client.models.bookmark_dto.BookmarkDto] | None

Returns all bookmarked pages for a given volume

Args:

volume_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:

list[BookmarkDto]

async kavita_client.api.reader.get_api_reader_volume_bookmarks.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, volume_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.bookmark_dto.BookmarkDto]]

Returns all bookmarked pages for a given volume

Args:

volume_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[list[BookmarkDto]]

kavita_client.api.reader.get_api_reader_volume_bookmarks.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, volume_id: int | kavita_client.types.Unset = UNSET) → list[kavita_client.models.bookmark_dto.BookmarkDto] | None

Returns all bookmarked pages for a given volume

Args:

volume_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:

list[BookmarkDto]

kavita_client.api.reader.get_api_reader_volume_bookmarks.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, volume_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.bookmark_dto.BookmarkDto]]

Returns all bookmarked pages for a given volume

Args:

volume_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[list[BookmarkDto]]