kavita_client.api.want_to_read.post_api_want_to_read_v2

Module Contents

Functions

asyncio	Return all Series that are in the current logged in user’s Want to Read list, filtered
asyncio_detailed	Return all Series that are in the current logged in user’s Want to Read list, filtered
sync	Return all Series that are in the current logged in user’s Want to Read list, filtered
sync_detailed	Return all Series that are in the current logged in user’s Want to Read list, filtered

API

async kavita_client.api.want_to_read.post_api_want_to_read_v2.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.types.Unset = UNSET, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET, user_id: int | kavita_client.types.Unset = UNSET) → list[kavita_client.models.series_dto.SeriesDto] | None

Return all Series that are in the current logged in user’s Want to Read list, filtered

Args:

page_number (int | Unset): page_size (int | Unset): user_id (int | Unset): body (SeriesFilterV2Dto | Unset): body (SeriesFilterV2Dto | Unset): body (SeriesFilterV2Dto | 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.want_to_read.post_api_want_to_read_v2.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.types.Unset = UNSET, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET, user_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.series_dto.SeriesDto]]

Return all Series that are in the current logged in user’s Want to Read list, filtered

Args:

page_number (int | Unset): page_size (int | Unset): user_id (int | Unset): body (SeriesFilterV2Dto | Unset): body (SeriesFilterV2Dto | Unset): body (SeriesFilterV2Dto | 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.want_to_read.post_api_want_to_read_v2.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.types.Unset = UNSET, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET, user_id: int | kavita_client.types.Unset = UNSET) → list[kavita_client.models.series_dto.SeriesDto] | None

Return all Series that are in the current logged in user’s Want to Read list, filtered

Args:

page_number (int | Unset): page_size (int | Unset): user_id (int | Unset): body (SeriesFilterV2Dto | Unset): body (SeriesFilterV2Dto | Unset): body (SeriesFilterV2Dto | 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.want_to_read.post_api_want_to_read_v2.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.types.Unset = UNSET, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET, user_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.series_dto.SeriesDto]]

Return all Series that are in the current logged in user’s Want to Read list, filtered

Args:

page_number (int | Unset): page_size (int | Unset): user_id (int | Unset): body (SeriesFilterV2Dto | Unset): body (SeriesFilterV2Dto | Unset): body (SeriesFilterV2Dto | 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]]