kavita_client.api.library.get_api_library_list

Module Contents

Functions

asyncio	Returns a list of directories for a given path. If path is empty, returns root drives.
asyncio_detailed	Returns a list of directories for a given path. If path is empty, returns root drives.
sync	Returns a list of directories for a given path. If path is empty, returns root drives.
sync_detailed	Returns a list of directories for a given path. If path is empty, returns root drives.

API

async kavita_client.api.library.get_api_library_list.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, path: str | kavita_client.types.Unset = UNSET) → list[kavita_client.models.directory_dto.DirectoryDto] | None

Returns a list of directories for a given path. If path is empty, returns root drives.

Args:

path (str | 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[DirectoryDto]

async kavita_client.api.library.get_api_library_list.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, path: str | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.directory_dto.DirectoryDto]]

Returns a list of directories for a given path. If path is empty, returns root drives.

Args:

path (str | 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[DirectoryDto]]

kavita_client.api.library.get_api_library_list.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, path: str | kavita_client.types.Unset = UNSET) → list[kavita_client.models.directory_dto.DirectoryDto] | None

Returns a list of directories for a given path. If path is empty, returns root drives.

Args:

path (str | 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[DirectoryDto]

kavita_client.api.library.get_api_library_list.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, path: str | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.directory_dto.DirectoryDto]]

Returns a list of directories for a given path. If path is empty, returns root drives.

Args:

path (str | 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[DirectoryDto]]