kavita_client.api.collection.get_api_collection_single

Module Contents

Functions

asyncio	Returns a single Collection tag by Id for a given user
asyncio_detailed	Returns a single Collection tag by Id for a given user
sync	Returns a single Collection tag by Id for a given user
sync_detailed	Returns a single Collection tag by Id for a given user

API

async kavita_client.api.collection.get_api_collection_single.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, collection_id: int | kavita_client.types.Unset = UNSET) → kavita_client.models.app_user_collection_dto.AppUserCollectionDto | None

Returns a single Collection tag by Id for a given user

Args:

collection_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:

AppUserCollectionDto

async kavita_client.api.collection.get_api_collection_single.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, collection_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.app_user_collection_dto.AppUserCollectionDto]

Returns a single Collection tag by Id for a given user

Args:

collection_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[AppUserCollectionDto]

kavita_client.api.collection.get_api_collection_single.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, collection_id: int | kavita_client.types.Unset = UNSET) → kavita_client.models.app_user_collection_dto.AppUserCollectionDto | None

Returns a single Collection tag by Id for a given user

Args:

collection_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:

AppUserCollectionDto

kavita_client.api.collection.get_api_collection_single.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, collection_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.app_user_collection_dto.AppUserCollectionDto]

Returns a single Collection tag by Id for a given user

Args:

collection_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[AppUserCollectionDto]