kavita_client.api.account.post_api_account_forgot_password

Module Contents

Functions

asyncio	Will send user a link to update their password to their email or prompt them if not accessible
asyncio_detailed	Will send user a link to update their password to their email or prompt them if not accessible
sync	Will send user a link to update their password to their email or prompt them if not accessible
sync_detailed	Will send user a link to update their password to their email or prompt them if not accessible

API

async kavita_client.api.account.post_api_account_forgot_password.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, email: str | kavita_client.types.Unset = UNSET) → str | None

Will send user a link to update their password to their email or prompt them if not accessible

Args:

email (str | 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.account.post_api_account_forgot_password.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, email: str | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[str]

Will send user a link to update their password to their email or prompt them if not accessible

Args:

email (str | 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.account.post_api_account_forgot_password.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, email: str | kavita_client.types.Unset = UNSET) → str | None

Will send user a link to update their password to their email or prompt them if not accessible

Args:

email (str | 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.account.post_api_account_forgot_password.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, email: str | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[str]

Will send user a link to update their password to their email or prompt them if not accessible

Args:

email (str | 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]