kavita_client.api.library.post_api_library_scan

Module Contents

Functions

asyncio_detailed	Scans a given library for file changes.
sync_detailed	Scans a given library for file changes.

API

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

Scans a given library for file changes.

Args:

library_id (int | Unset): force (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[Any]

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

Scans a given library for file changes.

Args:

library_id (int | Unset): force (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[Any]