kavita_client.api.rating.get_api_rating_overall_series

Module Contents

Functions

asyncio	Overall rating from all Kavita users for a given Series
asyncio_detailed	Overall rating from all Kavita users for a given Series
sync	Overall rating from all Kavita users for a given Series
sync_detailed	Overall rating from all Kavita users for a given Series

API

async kavita_client.api.rating.get_api_rating_overall_series.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET) → kavita_client.models.rating_dto.RatingDto | None

Overall rating from all Kavita users for a given Series

If the authenticated user is the only user to have rated the series, returns 0

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:

RatingDto

async kavita_client.api.rating.get_api_rating_overall_series.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.rating_dto.RatingDto]

Overall rating from all Kavita users for a given Series

If the authenticated user is the only user to have rated the series, returns 0

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

kavita_client.api.rating.get_api_rating_overall_series.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET) → kavita_client.models.rating_dto.RatingDto | None

Overall rating from all Kavita users for a given Series

If the authenticated user is the only user to have rated the series, returns 0

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:

RatingDto

kavita_client.api.rating.get_api_rating_overall_series.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.rating_dto.RatingDto]

Overall rating from all Kavita users for a given Series

If the authenticated user is the only user to have rated the series, returns 0

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