kavita_client.api.upload.post_api_upload_upload_by_url

Module Contents

Functions

asyncio	This stores a file (image) in temp directory for use in a cover image replacement flow. This is automatically cleaned up.
asyncio_detailed	This stores a file (image) in temp directory for use in a cover image replacement flow. This is automatically cleaned up.
sync	This stores a file (image) in temp directory for use in a cover image replacement flow. This is automatically cleaned up.
sync_detailed	This stores a file (image) in temp directory for use in a cover image replacement flow. This is automatically cleaned up.

API

async kavita_client.api.upload.post_api_upload_upload_by_url.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.upload_url_dto.UploadUrlDto | kavita_client.models.upload_url_dto.UploadUrlDto | kavita_client.models.upload_url_dto.UploadUrlDto | kavita_client.types.Unset = UNSET) → str | None

This stores a file (image) in temp directory for use in a cover image replacement flow. This is automatically cleaned up.

Args:

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

str

async kavita_client.api.upload.post_api_upload_upload_by_url.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.upload_url_dto.UploadUrlDto | kavita_client.models.upload_url_dto.UploadUrlDto | kavita_client.models.upload_url_dto.UploadUrlDto | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[str]

This stores a file (image) in temp directory for use in a cover image replacement flow. This is automatically cleaned up.

Args:

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

kavita_client.api.upload.post_api_upload_upload_by_url.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.upload_url_dto.UploadUrlDto | kavita_client.models.upload_url_dto.UploadUrlDto | kavita_client.models.upload_url_dto.UploadUrlDto | kavita_client.types.Unset = UNSET) → str | None

This stores a file (image) in temp directory for use in a cover image replacement flow. This is automatically cleaned up.

Args:

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

str

kavita_client.api.upload.post_api_upload_upload_by_url.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.upload_url_dto.UploadUrlDto | kavita_client.models.upload_url_dto.UploadUrlDto | kavita_client.models.upload_url_dto.UploadUrlDto | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[str]

This stores a file (image) in temp directory for use in a cover image replacement flow. This is automatically cleaned up.

Args:

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