kavita_client.api.series.get_api_series_metadata

Module Contents

Functions

asyncio	Returns metadata for a given series
asyncio_detailed	Returns metadata for a given series
sync	Returns metadata for a given series
sync_detailed	Returns metadata for a given series

API

async kavita_client.api.series.get_api_series_metadata.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET) → kavita_client.models.series_metadata_dto.SeriesMetadataDto | None

Returns metadata for a given series

Args:

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

SeriesMetadataDto

async kavita_client.api.series.get_api_series_metadata.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.series_metadata_dto.SeriesMetadataDto]

Returns metadata for a given series

Args:

series_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[SeriesMetadataDto]

kavita_client.api.series.get_api_series_metadata.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET) → kavita_client.models.series_metadata_dto.SeriesMetadataDto | None

Returns metadata for a given series

Args:

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

SeriesMetadataDto

kavita_client.api.series.get_api_series_metadata.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, series_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.series_metadata_dto.SeriesMetadataDto]

Returns metadata for a given series

Args:

series_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[SeriesMetadataDto]