kavita_client.api.library.post_api_library_has_files_at_root

Module Contents

Functions

asyncio	For each root, checks if there are any supported files at root to warn the user during library creation about an invalid setup
asyncio_detailed	For each root, checks if there are any supported files at root to warn the user during library creation about an invalid setup
sync	For each root, checks if there are any supported files at root to warn the user during library creation about an invalid setup
sync_detailed	For each root, checks if there are any supported files at root to warn the user during library creation about an invalid setup

API

async kavita_client.api.library.post_api_library_has_files_at_root.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.check_for_files_in_folder_roots_dto.CheckForFilesInFolderRootsDto | kavita_client.models.check_for_files_in_folder_roots_dto.CheckForFilesInFolderRootsDto | kavita_client.models.check_for_files_in_folder_roots_dto.CheckForFilesInFolderRootsDto | kavita_client.types.Unset = UNSET) → list[str] | None

For each root, checks if there are any supported files at root to warn the user during library creation about an invalid setup

Args:

body (CheckForFilesInFolderRootsDto | Unset): body (CheckForFilesInFolderRootsDto | Unset): body (CheckForFilesInFolderRootsDto | 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:

list[str]

async kavita_client.api.library.post_api_library_has_files_at_root.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.check_for_files_in_folder_roots_dto.CheckForFilesInFolderRootsDto | kavita_client.models.check_for_files_in_folder_roots_dto.CheckForFilesInFolderRootsDto | kavita_client.models.check_for_files_in_folder_roots_dto.CheckForFilesInFolderRootsDto | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[str]]

For each root, checks if there are any supported files at root to warn the user during library creation about an invalid setup

Args:

body (CheckForFilesInFolderRootsDto | Unset): body (CheckForFilesInFolderRootsDto | Unset): body (CheckForFilesInFolderRootsDto | 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[list[str]]

kavita_client.api.library.post_api_library_has_files_at_root.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.check_for_files_in_folder_roots_dto.CheckForFilesInFolderRootsDto | kavita_client.models.check_for_files_in_folder_roots_dto.CheckForFilesInFolderRootsDto | kavita_client.models.check_for_files_in_folder_roots_dto.CheckForFilesInFolderRootsDto | kavita_client.types.Unset = UNSET) → list[str] | None

For each root, checks if there are any supported files at root to warn the user during library creation about an invalid setup

Args:

body (CheckForFilesInFolderRootsDto | Unset): body (CheckForFilesInFolderRootsDto | Unset): body (CheckForFilesInFolderRootsDto | 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:

list[str]

kavita_client.api.library.post_api_library_has_files_at_root.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.check_for_files_in_folder_roots_dto.CheckForFilesInFolderRootsDto | kavita_client.models.check_for_files_in_folder_roots_dto.CheckForFilesInFolderRootsDto | kavita_client.models.check_for_files_in_folder_roots_dto.CheckForFilesInFolderRootsDto | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[str]]

For each root, checks if there are any supported files at root to warn the user during library creation about an invalid setup

Args:

body (CheckForFilesInFolderRootsDto | Unset): body (CheckForFilesInFolderRootsDto | Unset): body (CheckForFilesInFolderRootsDto | 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[list[str]]