kavita_client.api.person.get_api_person_roles

Module Contents

Functions

asyncio	Returns all roles for a Person
asyncio_detailed	Returns all roles for a Person
sync	Returns all roles for a Person
sync_detailed	Returns all roles for a Person

API

async kavita_client.api.person.get_api_person_roles.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, person_id: int | kavita_client.types.Unset = UNSET) → list[kavita_client.models.person_role.PersonRole] | None

Returns all roles for a Person

Args:

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

list[PersonRole]

async kavita_client.api.person.get_api_person_roles.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, person_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.person_role.PersonRole]]

Returns all roles for a Person

Args:

person_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[list[PersonRole]]

kavita_client.api.person.get_api_person_roles.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, person_id: int | kavita_client.types.Unset = UNSET) → list[kavita_client.models.person_role.PersonRole] | None

Returns all roles for a Person

Args:

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

list[PersonRole]

kavita_client.api.person.get_api_person_roles.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, person_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.person_role.PersonRole]]

Returns all roles for a Person

Args:

person_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[list[PersonRole]]