kavita_client.api.account.post_api_account_login

Module Contents

Functions

asyncio	Perform a login. Will send JWT Token of the logged in user back.
asyncio_detailed	Perform a login. Will send JWT Token of the logged in user back.
sync	Perform a login. Will send JWT Token of the logged in user back.
sync_detailed	Perform a login. Will send JWT Token of the logged in user back.

API

async kavita_client.api.account.post_api_account_login.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.login_dto.LoginDto | kavita_client.models.login_dto.LoginDto | kavita_client.models.login_dto.LoginDto | kavita_client.types.Unset = UNSET) → kavita_client.models.user_dto.UserDto | None

Perform a login. Will send JWT Token of the logged in user back.

Args:

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

UserDto

async kavita_client.api.account.post_api_account_login.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.login_dto.LoginDto | kavita_client.models.login_dto.LoginDto | kavita_client.models.login_dto.LoginDto | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.user_dto.UserDto]

Perform a login. Will send JWT Token of the logged in user back.

Args:

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

kavita_client.api.account.post_api_account_login.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.login_dto.LoginDto | kavita_client.models.login_dto.LoginDto | kavita_client.models.login_dto.LoginDto | kavita_client.types.Unset = UNSET) → kavita_client.models.user_dto.UserDto | None

Perform a login. Will send JWT Token of the logged in user back.

Args:

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

UserDto

kavita_client.api.account.post_api_account_login.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.login_dto.LoginDto | kavita_client.models.login_dto.LoginDto | kavita_client.models.login_dto.LoginDto | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.user_dto.UserDto]

Perform a login. Will send JWT Token of the logged in user back.

Args:

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