kavita_client.api.upload.post_api_upload_upload_by_file

Module Contents

Functions

asyncio	Stages an uploaded image file in the temp directory for use in a cover image replacement flow. This is automatically cleaned up.
asyncio_detailed	Stages an uploaded image file in the temp directory for use in a cover image replacement flow. This is automatically cleaned up.
sync	Stages an uploaded image file in the temp directory for use in a cover image replacement flow. This is automatically cleaned up.
sync_detailed	Stages an uploaded image file in the 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_file.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.post_api_upload_upload_by_file_body.PostApiUploadUploadByFileBody | kavita_client.types.Unset = UNSET) → str | None

Stages an uploaded image file in the temp directory for use in a cover image replacement flow. This is automatically cleaned up.

Args:

body (PostApiUploadUploadByFileBody | 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_file.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.post_api_upload_upload_by_file_body.PostApiUploadUploadByFileBody | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[str]

Stages an uploaded image file in the temp directory for use in a cover image replacement flow. This is automatically cleaned up.

Args:

body (PostApiUploadUploadByFileBody | 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_file.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.post_api_upload_upload_by_file_body.PostApiUploadUploadByFileBody | kavita_client.types.Unset = UNSET) → str | None

Stages an uploaded image file in the temp directory for use in a cover image replacement flow. This is automatically cleaned up.

Args:

body (PostApiUploadUploadByFileBody | 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_file.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.post_api_upload_upload_by_file_body.PostApiUploadUploadByFileBody | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[str]

Stages an uploaded image file in the temp directory for use in a cover image replacement flow. This is automatically cleaned up.

Args:

body (PostApiUploadUploadByFileBody | 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]