kavita_client.api.metadata.get_api_metadata_people

Module Contents

Functions

asyncio	Fetches people from the instance
asyncio_detailed	Fetches people from the instance
sync	Fetches people from the instance
sync_detailed	Fetches people from the instance

API

async kavita_client.api.metadata.get_api_metadata_people.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, library_ids: str | kavita_client.types.Unset = UNSET) → list[kavita_client.models.person_dto.PersonDto] | None

Fetches people from the instance

Args:

library_ids (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[PersonDto]

async kavita_client.api.metadata.get_api_metadata_people.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, library_ids: str | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.person_dto.PersonDto]]

Fetches people from the instance

Args:

library_ids (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[PersonDto]]

kavita_client.api.metadata.get_api_metadata_people.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, library_ids: str | kavita_client.types.Unset = UNSET) → list[kavita_client.models.person_dto.PersonDto] | None

Fetches people from the instance

Args:

library_ids (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[PersonDto]

kavita_client.api.metadata.get_api_metadata_people.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, library_ids: str | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.person_dto.PersonDto]]

Fetches people from the instance

Args:

library_ids (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[PersonDto]]