kavita_client.api.volume.get_api_volume

Module Contents

Functions

asyncio	Returns the appropriate Volume
asyncio_detailed	Returns the appropriate Volume
sync	Returns the appropriate Volume
sync_detailed	Returns the appropriate Volume

API

async kavita_client.api.volume.get_api_volume.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, volume_id: int | kavita_client.types.Unset = UNSET) → kavita_client.models.volume_dto.VolumeDto | None

Returns the appropriate Volume

Args:

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

VolumeDto

async kavita_client.api.volume.get_api_volume.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, volume_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.volume_dto.VolumeDto]

Returns the appropriate Volume

Args:

volume_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[VolumeDto]

kavita_client.api.volume.get_api_volume.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, volume_id: int | kavita_client.types.Unset = UNSET) → kavita_client.models.volume_dto.VolumeDto | None

Returns the appropriate Volume

Args:

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

VolumeDto

kavita_client.api.volume.get_api_volume.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, volume_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.volume_dto.VolumeDto]

Returns the appropriate Volume

Args:

volume_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[VolumeDto]