kavita_client.api.account.post_api_account_update_email

Module Contents

Functions

asyncio	Initiates the flow to update a user’s email address.
asyncio_detailed	Initiates the flow to update a user’s email address.
sync	Initiates the flow to update a user’s email address.
sync_detailed	Initiates the flow to update a user’s email address.

API

async kavita_client.api.account.post_api_account_update_email.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.update_email_dto.UpdateEmailDto | kavita_client.models.update_email_dto.UpdateEmailDto | kavita_client.models.update_email_dto.UpdateEmailDto | kavita_client.types.Unset = UNSET) → kavita_client.models.invite_user_response.InviteUserResponse | None

Initiates the flow to update a user’s email address.

If email is not setup, then the email address is not changed in this API. A confirmation link is sent/dumped which will validate the email. It must be confirmed for the email to update.

Args:

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

InviteUserResponse

async kavita_client.api.account.post_api_account_update_email.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.update_email_dto.UpdateEmailDto | kavita_client.models.update_email_dto.UpdateEmailDto | kavita_client.models.update_email_dto.UpdateEmailDto | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.invite_user_response.InviteUserResponse]

Initiates the flow to update a user’s email address.

If email is not setup, then the email address is not changed in this API. A confirmation link is sent/dumped which will validate the email. It must be confirmed for the email to update.

Args:

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

kavita_client.api.account.post_api_account_update_email.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.update_email_dto.UpdateEmailDto | kavita_client.models.update_email_dto.UpdateEmailDto | kavita_client.models.update_email_dto.UpdateEmailDto | kavita_client.types.Unset = UNSET) → kavita_client.models.invite_user_response.InviteUserResponse | None

Initiates the flow to update a user’s email address.

If email is not setup, then the email address is not changed in this API. A confirmation link is sent/dumped which will validate the email. It must be confirmed for the email to update.

Args:

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

InviteUserResponse

kavita_client.api.account.post_api_account_update_email.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.update_email_dto.UpdateEmailDto | kavita_client.models.update_email_dto.UpdateEmailDto | kavita_client.models.update_email_dto.UpdateEmailDto | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.invite_user_response.InviteUserResponse]

Initiates the flow to update a user’s email address.

If email is not setup, then the email address is not changed in this API. A confirmation link is sent/dumped which will validate the email. It must be confirmed for the email to update.

Args:

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