kavita_client.api.annotation.post_api_annotation_create

Module Contents

Functions

asyncio	Create a new Annotation for the user against a Chapter
asyncio_detailed	Create a new Annotation for the user against a Chapter
sync	Create a new Annotation for the user against a Chapter
sync_detailed	Create a new Annotation for the user against a Chapter

API

async kavita_client.api.annotation.post_api_annotation_create.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.annotation_dto.AnnotationDto | kavita_client.models.annotation_dto.AnnotationDto | kavita_client.models.annotation_dto.AnnotationDto | kavita_client.types.Unset = UNSET) → kavita_client.models.annotation_dto.AnnotationDto | None

Create a new Annotation for the user against a Chapter

Args:

body (AnnotationDto | Unset): body (AnnotationDto | Unset): body (AnnotationDto | 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:

AnnotationDto

async kavita_client.api.annotation.post_api_annotation_create.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.annotation_dto.AnnotationDto | kavita_client.models.annotation_dto.AnnotationDto | kavita_client.models.annotation_dto.AnnotationDto | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.annotation_dto.AnnotationDto]

Create a new Annotation for the user against a Chapter

Args:

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

kavita_client.api.annotation.post_api_annotation_create.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.annotation_dto.AnnotationDto | kavita_client.models.annotation_dto.AnnotationDto | kavita_client.models.annotation_dto.AnnotationDto | kavita_client.types.Unset = UNSET) → kavita_client.models.annotation_dto.AnnotationDto | None

Create a new Annotation for the user against a Chapter

Args:

body (AnnotationDto | Unset): body (AnnotationDto | Unset): body (AnnotationDto | 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:

AnnotationDto

kavita_client.api.annotation.post_api_annotation_create.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.annotation_dto.AnnotationDto | kavita_client.models.annotation_dto.AnnotationDto | kavita_client.models.annotation_dto.AnnotationDto | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.annotation_dto.AnnotationDto]

Create a new Annotation for the user against a Chapter

Args:

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