kavita_client.api.library.post_api_library_scan_folder

Module Contents

Functions

asyncio_detailed	Given a valid path, will invoke either a Scan Series or Scan Library. If the folder does not exist within Kavita, the request will be ignored
sync_detailed	Given a valid path, will invoke either a Scan Series or Scan Library. If the folder does not exist within Kavita, the request will be ignored

API

async kavita_client.api.library.post_api_library_scan_folder.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.scan_folder_dto.ScanFolderDto | kavita_client.models.scan_folder_dto.ScanFolderDto | kavita_client.models.scan_folder_dto.ScanFolderDto | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[Any]

Given a valid path, will invoke either a Scan Series or Scan Library. If the folder does not exist within Kavita, the request will be ignored

Args:

body (ScanFolderDto | Unset): body (ScanFolderDto | Unset): body (ScanFolderDto | 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[Any]

kavita_client.api.library.post_api_library_scan_folder.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.scan_folder_dto.ScanFolderDto | kavita_client.models.scan_folder_dto.ScanFolderDto | kavita_client.models.scan_folder_dto.ScanFolderDto | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[Any]

Given a valid path, will invoke either a Scan Series or Scan Library. If the folder does not exist within Kavita, the request will be ignored

Args:

body (ScanFolderDto | Unset): body (ScanFolderDto | Unset): body (ScanFolderDto | 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[Any]