kavita_client.api.library.get_api_library

Module Contents

Functions

asyncio	Return a specific library
asyncio_detailed	Return a specific library
sync	Return a specific library
sync_detailed	Return a specific library

API

async kavita_client.api.library.get_api_library.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, library_id: int | kavita_client.types.Unset = UNSET) → kavita_client.models.library_dto.LibraryDto | None

Return a specific library

If the user is not an admin, only id, type, and name will be returned

(Kavita.Models.DTOs.LiteLibraryDto)

Args:

library_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:

LibraryDto

async kavita_client.api.library.get_api_library.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, library_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.library_dto.LibraryDto]

Return a specific library

If the user is not an admin, only id, type, and name will be returned

(Kavita.Models.DTOs.LiteLibraryDto)

Args:

library_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[LibraryDto]

kavita_client.api.library.get_api_library.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, library_id: int | kavita_client.types.Unset = UNSET) → kavita_client.models.library_dto.LibraryDto | None

Return a specific library

If the user is not an admin, only id, type, and name will be returned

(Kavita.Models.DTOs.LiteLibraryDto)

Args:

library_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:

LibraryDto

kavita_client.api.library.get_api_library.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, library_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.library_dto.LibraryDto]

Return a specific library

If the user is not an admin, only id, type, and name will be returned

(Kavita.Models.DTOs.LiteLibraryDto)

Args:

library_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[LibraryDto]