kavita_client.api.metadata.get_api_metadata_people_by_role

Module Contents

Functions

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

API

async kavita_client.api.metadata.get_api_metadata_people_by_role.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, role: kavita_client.models.person_role.PersonRole | kavita_client.types.Unset = UNSET) → list[kavita_client.models.person_dto.PersonDto] | None

Fetches people from the instance by role

Args:

role (PersonRole | Unset): Members:

• 3 — Writer

• 4 — Penciller

• 5 — Inker

• 6 — Colorist

• 7 — Letterer

• 8 — CoverArtist

• 9 — Editor

• 10 — Publisher

• 11 — Character

• 12 — Translator

• 13 — Imprint

• 14 — Team

• 15 — Location

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_by_role.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, role: kavita_client.models.person_role.PersonRole | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.person_dto.PersonDto]]

Fetches people from the instance by role

Args:

role (PersonRole | Unset): Members:

• 3 — Writer

• 4 — Penciller

• 5 — Inker

• 6 — Colorist

• 7 — Letterer

• 8 — CoverArtist

• 9 — Editor

• 10 — Publisher

• 11 — Character

• 12 — Translator

• 13 — Imprint

• 14 — Team

• 15 — Location

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_by_role.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, role: kavita_client.models.person_role.PersonRole | kavita_client.types.Unset = UNSET) → list[kavita_client.models.person_dto.PersonDto] | None

Fetches people from the instance by role

Args:

role (PersonRole | Unset): Members:

• 3 — Writer

• 4 — Penciller

• 5 — Inker

• 6 — Colorist

• 7 — Letterer

• 8 — CoverArtist

• 9 — Editor

• 10 — Publisher

• 11 — Character

• 12 — Translator

• 13 — Imprint

• 14 — Team

• 15 — Location

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_by_role.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, role: kavita_client.models.person_role.PersonRole | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.person_dto.PersonDto]]

Fetches people from the instance by role

Args:

role (PersonRole | Unset): Members:

• 3 — Writer

• 4 — Penciller

• 5 — Inker

• 6 — Colorist

• 7 — Letterer

• 8 — CoverArtist

• 9 — Editor

• 10 — Publisher

• 11 — Character

• 12 — Translator

• 13 — Imprint

• 14 — Team

• 15 — Location

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