kavita_client.api.collection.get_api_collection

Module Contents

Functions

asyncio	Returns all Collection tags for a given User
asyncio_detailed	Returns all Collection tags for a given User
sync	Returns all Collection tags for a given User
sync_detailed	Returns all Collection tags for a given User

API

async kavita_client.api.collection.get_api_collection.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, owned_only: bool | kavita_client.types.Unset = False, sort_by_last_modified: bool | kavita_client.types.Unset = False) → list[kavita_client.models.app_user_collection_dto.AppUserCollectionDto] | None

Returns all Collection tags for a given User

Args:

owned_only (bool | Unset): Default: False. 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[AppUserCollectionDto]

async kavita_client.api.collection.get_api_collection.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, owned_only: bool | kavita_client.types.Unset = False, sort_by_last_modified: bool | kavita_client.types.Unset = False) → kavita_client.types.Response[list[kavita_client.models.app_user_collection_dto.AppUserCollectionDto]]

Returns all Collection tags for a given User

Args:

owned_only (bool | Unset): Default: False. 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[AppUserCollectionDto]]

kavita_client.api.collection.get_api_collection.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, owned_only: bool | kavita_client.types.Unset = False, sort_by_last_modified: bool | kavita_client.types.Unset = False) → list[kavita_client.models.app_user_collection_dto.AppUserCollectionDto] | None

Returns all Collection tags for a given User

Args:

owned_only (bool | Unset): Default: False. 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[AppUserCollectionDto]

kavita_client.api.collection.get_api_collection.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, owned_only: bool | kavita_client.types.Unset = False, sort_by_last_modified: bool | kavita_client.types.Unset = False) → kavita_client.types.Response[list[kavita_client.models.app_user_collection_dto.AppUserCollectionDto]]

Returns all Collection tags for a given User

Args:

owned_only (bool | Unset): Default: False. 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[AppUserCollectionDto]]