kavita_client.api.person.post_api_person_all

Module Contents

Functions

asyncio	Returns a list of authors and artists for browsing
asyncio_detailed	Returns a list of authors and artists for browsing
sync	Returns a list of authors and artists for browsing
sync_detailed	Returns a list of authors and artists for browsing

API

async kavita_client.api.person.post_api_person_all.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.person_filter_dto.PersonFilterDto | kavita_client.models.person_filter_dto.PersonFilterDto | kavita_client.models.person_filter_dto.PersonFilterDto | kavita_client.types.Unset = UNSET, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET) → list[kavita_client.models.browse_person_dto.BrowsePersonDto] | None

Returns a list of authors and artists for browsing

Args:

page_number (int | Unset): page_size (int | Unset): body (PersonFilterDto | Unset): body (PersonFilterDto | Unset): body (PersonFilterDto | 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[BrowsePersonDto]

async kavita_client.api.person.post_api_person_all.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.person_filter_dto.PersonFilterDto | kavita_client.models.person_filter_dto.PersonFilterDto | kavita_client.models.person_filter_dto.PersonFilterDto | kavita_client.types.Unset = UNSET, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.browse_person_dto.BrowsePersonDto]]

Returns a list of authors and artists for browsing

Args:

page_number (int | Unset): page_size (int | Unset): body (PersonFilterDto | Unset): body (PersonFilterDto | Unset): body (PersonFilterDto | 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[BrowsePersonDto]]

kavita_client.api.person.post_api_person_all.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.person_filter_dto.PersonFilterDto | kavita_client.models.person_filter_dto.PersonFilterDto | kavita_client.models.person_filter_dto.PersonFilterDto | kavita_client.types.Unset = UNSET, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET) → list[kavita_client.models.browse_person_dto.BrowsePersonDto] | None

Returns a list of authors and artists for browsing

Args:

page_number (int | Unset): page_size (int | Unset): body (PersonFilterDto | Unset): body (PersonFilterDto | Unset): body (PersonFilterDto | 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[BrowsePersonDto]

kavita_client.api.person.post_api_person_all.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.person_filter_dto.PersonFilterDto | kavita_client.models.person_filter_dto.PersonFilterDto | kavita_client.models.person_filter_dto.PersonFilterDto | kavita_client.types.Unset = UNSET, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.browse_person_dto.BrowsePersonDto]]

Returns a list of authors and artists for browsing

Args:

page_number (int | Unset): page_size (int | Unset): body (PersonFilterDto | Unset): body (PersonFilterDto | Unset): body (PersonFilterDto | 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[BrowsePersonDto]]