kavita_client.api.series.get_api_series_currently_reading

Module Contents

Functions

asyncio	Get series a user is currently reading, requires the user to share their profile
asyncio_detailed	Get series a user is currently reading, requires the user to share their profile
sync	Get series a user is currently reading, requires the user to share their profile
sync_detailed	Get series a user is currently reading, requires the user to share their profile

API

async kavita_client.api.series.get_api_series_currently_reading.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, 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

Get series a user is currently reading, requires the user to share their profile

Args:

page_number (int | Unset): page_size (int | Unset): user_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[SeriesDto]

async kavita_client.api.series.get_api_series_currently_reading.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, 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]]

Get series a user is currently reading, requires the user to share their profile

Args:

page_number (int | Unset): page_size (int | Unset): user_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[SeriesDto]]

kavita_client.api.series.get_api_series_currently_reading.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, 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

Get series a user is currently reading, requires the user to share their profile

Args:

page_number (int | Unset): page_size (int | Unset): user_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[SeriesDto]

kavita_client.api.series.get_api_series_currently_reading.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, 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]]

Get series a user is currently reading, requires the user to share their profile

Args:

page_number (int | Unset): page_size (int | Unset): user_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[SeriesDto]]