kavita_client.api.volume.delete_api_volume

Module Contents

Functions

asyncio	Delete the Volume from the DB
asyncio_detailed	Delete the Volume from the DB
sync	Delete the Volume from the DB
sync_detailed	Delete the Volume from the DB

API

async kavita_client.api.volume.delete_api_volume.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, volume_id: int | kavita_client.types.Unset = UNSET) → bool | None

Delete the Volume from the DB

Args:

volume_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.volume.delete_api_volume.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, volume_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[bool]

Delete the Volume from the DB

Args:

volume_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.volume.delete_api_volume.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, volume_id: int | kavita_client.types.Unset = UNSET) → bool | None

Delete the Volume from the DB

Args:

volume_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.volume.delete_api_volume.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, volume_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[bool]

Delete the Volume from the DB

Args:

volume_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]