kavita_client.api.reading_list.get_api_reading_list_people

Module Contents

Functions

asyncio	Returns a list of a given role associated with the reading list
asyncio_detailed	Returns a list of a given role associated with the reading list
sync	Returns a list of a given role associated with the reading list
sync_detailed	Returns a list of a given role associated with the reading list

API

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

Returns a list of a given role associated with the reading list

Args:

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

Returns a list of a given role associated with the reading list

Args:

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

Returns a list of a given role associated with the reading list

Args:

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

Returns a list of a given role associated with the reading list

Args:

reading_list_id (int | Unset): 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]]