kavita_client.api.reading_list.post_api_reading_list_lists

Module Contents

Functions

asyncio	Returns reading lists (paginated) for a given user.
asyncio_detailed	Returns reading lists (paginated) for a given user.
sync	Returns reading lists (paginated) for a given user.
sync_detailed	Returns reading lists (paginated) for a given user.

API

async kavita_client.api.reading_list.post_api_reading_list_lists.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, include_promoted: bool | kavita_client.types.Unset = True, sort_by_last_modified: bool | kavita_client.types.Unset = False) → list[kavita_client.models.reading_list_dto.ReadingListDto] | None

Returns reading lists (paginated) for a given user.

Args:

page_number (int | Unset): page_size (int | Unset): include_promoted (bool | Unset): Default: True. sort_by_last_modified (bool | Unset): Default: False.

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

async kavita_client.api.reading_list.post_api_reading_list_lists.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, include_promoted: bool | kavita_client.types.Unset = True, sort_by_last_modified: bool | kavita_client.types.Unset = False) → kavita_client.types.Response[list[kavita_client.models.reading_list_dto.ReadingListDto]]

Returns reading lists (paginated) for a given user.

Args:

page_number (int | Unset): page_size (int | Unset): include_promoted (bool | Unset): Default: True. sort_by_last_modified (bool | Unset): Default: False.

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

kavita_client.api.reading_list.post_api_reading_list_lists.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, include_promoted: bool | kavita_client.types.Unset = True, sort_by_last_modified: bool | kavita_client.types.Unset = False) → list[kavita_client.models.reading_list_dto.ReadingListDto] | None

Returns reading lists (paginated) for a given user.

Args:

page_number (int | Unset): page_size (int | Unset): include_promoted (bool | Unset): Default: True. sort_by_last_modified (bool | Unset): Default: False.

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

kavita_client.api.reading_list.post_api_reading_list_lists.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, include_promoted: bool | kavita_client.types.Unset = True, sort_by_last_modified: bool | kavita_client.types.Unset = False) → kavita_client.types.Response[list[kavita_client.models.reading_list_dto.ReadingListDto]]

Returns reading lists (paginated) for a given user.

Args:

page_number (int | Unset): page_size (int | Unset): include_promoted (bool | Unset): Default: True. sort_by_last_modified (bool | Unset): Default: False.

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