kavita_client.api.series.post_api_series_all_v_2

Module Contents

Functions

asyncio	Returns all series for the library
asyncio_detailed	Returns all series for the library
sync	Returns all series for the library
sync_detailed	Returns all series for the library

API

async kavita_client.api.series.post_api_series_all_v_2.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.types.Unset = UNSET, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET, user_id: int | kavita_client.types.Unset = UNSET, context: kavita_client.models.query_context.QueryContext | kavita_client.types.Unset = UNSET) → list[kavita_client.models.series_dto.SeriesDto] | None

Returns all series for the library

Args:

page_number (int | Unset): page_size (int | Unset): user_id (int | Unset): context (QueryContext | Unset): Members:

• 1 — None

• 2 — Search

• 4 — Dashboard

body (SeriesFilterV2Dto | Unset): body (SeriesFilterV2Dto | Unset): body (SeriesFilterV2Dto | 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[SeriesDto]

async kavita_client.api.series.post_api_series_all_v_2.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.types.Unset = UNSET, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET, user_id: int | kavita_client.types.Unset = UNSET, context: kavita_client.models.query_context.QueryContext | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.series_dto.SeriesDto]]

Returns all series for the library

Args:

page_number (int | Unset): page_size (int | Unset): user_id (int | Unset): context (QueryContext | Unset): Members:

• 1 — None

• 2 — Search

• 4 — Dashboard

body (SeriesFilterV2Dto | Unset): body (SeriesFilterV2Dto | Unset): body (SeriesFilterV2Dto | 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[SeriesDto]]

kavita_client.api.series.post_api_series_all_v_2.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.types.Unset = UNSET, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET, user_id: int | kavita_client.types.Unset = UNSET, context: kavita_client.models.query_context.QueryContext | kavita_client.types.Unset = UNSET) → list[kavita_client.models.series_dto.SeriesDto] | None

Returns all series for the library

Args:

page_number (int | Unset): page_size (int | Unset): user_id (int | Unset): context (QueryContext | Unset): Members:

• 1 — None

• 2 — Search

• 4 — Dashboard

body (SeriesFilterV2Dto | Unset): body (SeriesFilterV2Dto | Unset): body (SeriesFilterV2Dto | 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[SeriesDto]

kavita_client.api.series.post_api_series_all_v_2.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.models.series_filter_v2_dto.SeriesFilterV2Dto | kavita_client.types.Unset = UNSET, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET, user_id: int | kavita_client.types.Unset = UNSET, context: kavita_client.models.query_context.QueryContext | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.series_dto.SeriesDto]]

Returns all series for the library

Args:

page_number (int | Unset): page_size (int | Unset): user_id (int | Unset): context (QueryContext | Unset): Members:

• 1 — None

• 2 — Search

• 4 — Dashboard

body (SeriesFilterV2Dto | Unset): body (SeriesFilterV2Dto | Unset): body (SeriesFilterV2Dto | 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[SeriesDto]]