kavita_client.api.library.delete_api_library_delete

Module Contents

Functions

asyncio	Deletes the library and all series within it.
asyncio_detailed	Deletes the library and all series within it.
sync	Deletes the library and all series within it.
sync_detailed	Deletes the library and all series within it.

API

async kavita_client.api.library.delete_api_library_delete.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, library_id: int | kavita_client.types.Unset = UNSET) → bool | None

Deletes the library and all series within it.

This does not touch any files

Args:

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

bool

async kavita_client.api.library.delete_api_library_delete.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, library_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[bool]

Deletes the library and all series within it.

This does not touch any files

Args:

library_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[bool]

kavita_client.api.library.delete_api_library_delete.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, library_id: int | kavita_client.types.Unset = UNSET) → bool | None

Deletes the library and all series within it.

This does not touch any files

Args:

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

bool

kavita_client.api.library.delete_api_library_delete.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, library_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[bool]

Deletes the library and all series within it.

This does not touch any files

Args:

library_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[bool]