kavita_client.api.annotation.get_api_annotation_all_for_series

Module Contents

Functions

asyncio	Returns all annotations by Series
asyncio_detailed	Returns all annotations by Series
sync	Returns all annotations by Series
sync_detailed	Returns all annotations by Series

API

async kavita_client.api.annotation.get_api_annotation_all_for_series.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET) → list[kavita_client.models.annotation_dto.AnnotationDto] | None

Returns all annotations by Series

Args:

series_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[AnnotationDto]

async kavita_client.api.annotation.get_api_annotation_all_for_series.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.annotation_dto.AnnotationDto]]

Returns all annotations by Series

Args:

series_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[AnnotationDto]]

kavita_client.api.annotation.get_api_annotation_all_for_series.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET) → list[kavita_client.models.annotation_dto.AnnotationDto] | None

Returns all annotations by Series

Args:

series_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[AnnotationDto]

kavita_client.api.annotation.get_api_annotation_all_for_series.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.annotation_dto.AnnotationDto]]

Returns all annotations by Series

Args:

series_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[AnnotationDto]]