kavita_client.api.person.get_api_person_search

Module Contents

Functions

asyncio	Find a person by name or alias against a query string
asyncio_detailed	Find a person by name or alias against a query string
sync	Find a person by name or alias against a query string
sync_detailed	Find a person by name or alias against a query string

API

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

Find a person by name or alias against a query string

Args:

query_string (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.person.get_api_person_search.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, query_string: str | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.person_dto.PersonDto]]

Find a person by name or alias against a query string

Args:

query_string (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.person.get_api_person_search.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, query_string: str | kavita_client.types.Unset = UNSET) → list[kavita_client.models.person_dto.PersonDto] | None

Find a person by name or alias against a query string

Args:

query_string (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.person.get_api_person_search.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, query_string: str | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.person_dto.PersonDto]]

Find a person by name or alias against a query string

Args:

query_string (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]]