kavita_client.api.users.post_api_users_update_preferences

Module Contents

Functions

asyncio	Update the user preferences
asyncio_detailed	Update the user preferences
sync	Update the user preferences
sync_detailed	Update the user preferences

API

async kavita_client.api.users.post_api_users_update_preferences.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.user_preferences_dto.UserPreferencesDto | kavita_client.models.user_preferences_dto.UserPreferencesDto | kavita_client.models.user_preferences_dto.UserPreferencesDto | kavita_client.types.Unset = UNSET) → kavita_client.models.user_preferences_dto.UserPreferencesDto | None

Update the user preferences

If the user has ReadOnly role, they will not be able to perform this action

Args:

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

UserPreferencesDto

async kavita_client.api.users.post_api_users_update_preferences.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.user_preferences_dto.UserPreferencesDto | kavita_client.models.user_preferences_dto.UserPreferencesDto | kavita_client.models.user_preferences_dto.UserPreferencesDto | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.user_preferences_dto.UserPreferencesDto]

Update the user preferences

If the user has ReadOnly role, they will not be able to perform this action

Args:

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

kavita_client.api.users.post_api_users_update_preferences.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.user_preferences_dto.UserPreferencesDto | kavita_client.models.user_preferences_dto.UserPreferencesDto | kavita_client.models.user_preferences_dto.UserPreferencesDto | kavita_client.types.Unset = UNSET) → kavita_client.models.user_preferences_dto.UserPreferencesDto | None

Update the user preferences

If the user has ReadOnly role, they will not be able to perform this action

Args:

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

UserPreferencesDto

kavita_client.api.users.post_api_users_update_preferences.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.user_preferences_dto.UserPreferencesDto | kavita_client.models.user_preferences_dto.UserPreferencesDto | kavita_client.models.user_preferences_dto.UserPreferencesDto | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.user_preferences_dto.UserPreferencesDto]

Update the user preferences

If the user has ReadOnly role, they will not be able to perform this action

Args:

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