kavita_client.api.reader.get_api_reader_time_left

Module Contents

Functions

asyncio	For the current user, returns an estimate on how long it would take to finish reading the series.
asyncio_detailed	For the current user, returns an estimate on how long it would take to finish reading the series.
sync	For the current user, returns an estimate on how long it would take to finish reading the series.
sync_detailed	For the current user, returns an estimate on how long it would take to finish reading the series.

API

async kavita_client.api.reader.get_api_reader_time_left.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET) → kavita_client.models.hour_estimate_range_dto.HourEstimateRangeDto | None

For the current user, returns an estimate on how long it would take to finish reading the series.

For Epubs, this does not check words inside a chapter due to overhead so may not work in all cases.

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:

HourEstimateRangeDto

async kavita_client.api.reader.get_api_reader_time_left.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.hour_estimate_range_dto.HourEstimateRangeDto]

For the current user, returns an estimate on how long it would take to finish reading the series.

For Epubs, this does not check words inside a chapter due to overhead so may not work in all cases.

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

kavita_client.api.reader.get_api_reader_time_left.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET) → kavita_client.models.hour_estimate_range_dto.HourEstimateRangeDto | None

For the current user, returns an estimate on how long it would take to finish reading the series.

For Epubs, this does not check words inside a chapter due to overhead so may not work in all cases.

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:

HourEstimateRangeDto

kavita_client.api.reader.get_api_reader_time_left.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.hour_estimate_range_dto.HourEstimateRangeDto]

For the current user, returns an estimate on how long it would take to finish reading the series.

For Epubs, this does not check words inside a chapter due to overhead so may not work in all cases.

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