kavita_client.api.collection.get_api_collection_all_series

Module Contents

Functions

asyncio	Returns all collections that contain the Series for the user with the option to allow for promoted collections (non-user owned)
asyncio_detailed	Returns all collections that contain the Series for the user with the option to allow for promoted collections (non-user owned)
sync	Returns all collections that contain the Series for the user with the option to allow for promoted collections (non-user owned)
sync_detailed	Returns all collections that contain the Series for the user with the option to allow for promoted collections (non-user owned)

API

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

Returns all collections that contain the Series for the user with the option to allow for promoted collections (non-user owned)

Args:

series_id (int | Unset): owned_only (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_all_series.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET, owned_only: bool | kavita_client.types.Unset = False) → kavita_client.types.Response[list[kavita_client.models.app_user_collection_dto.AppUserCollectionDto]]

Returns all collections that contain the Series for the user with the option to allow for promoted collections (non-user owned)

Args:

series_id (int | Unset): owned_only (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_all_series.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET, owned_only: bool | kavita_client.types.Unset = False) → list[kavita_client.models.app_user_collection_dto.AppUserCollectionDto] | None

Returns all collections that contain the Series for the user with the option to allow for promoted collections (non-user owned)

Args:

series_id (int | Unset): owned_only (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_all_series.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET, owned_only: bool | kavita_client.types.Unset = False) → kavita_client.types.Response[list[kavita_client.models.app_user_collection_dto.AppUserCollectionDto]]

Returns all collections that contain the Series for the user with the option to allow for promoted collections (non-user owned)

Args:

series_id (int | Unset): owned_only (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]]