kavita_client.api.account.post_api_account_register

Module Contents

Functions

asyncio	Register the first user (admin) on the server. Will not do anything if an admin is already confirmed
asyncio_detailed	Register the first user (admin) on the server. Will not do anything if an admin is already confirmed
sync	Register the first user (admin) on the server. Will not do anything if an admin is already confirmed
sync_detailed	Register the first user (admin) on the server. Will not do anything if an admin is already confirmed

API

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

Register the first user (admin) on the server. Will not do anything if an admin is already confirmed

Args:

body (RegisterDto | Unset): body (RegisterDto | Unset): body (RegisterDto | 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_register.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.register_dto.RegisterDto | kavita_client.models.register_dto.RegisterDto | kavita_client.models.register_dto.RegisterDto | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.user_dto.UserDto]

Register the first user (admin) on the server. Will not do anything if an admin is already confirmed

Args:

body (RegisterDto | Unset): body (RegisterDto | Unset): body (RegisterDto | 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_register.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.register_dto.RegisterDto | kavita_client.models.register_dto.RegisterDto | kavita_client.models.register_dto.RegisterDto | kavita_client.types.Unset = UNSET) → kavita_client.models.user_dto.UserDto | None

Register the first user (admin) on the server. Will not do anything if an admin is already confirmed

Args:

body (RegisterDto | Unset): body (RegisterDto | Unset): body (RegisterDto | 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_register.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.register_dto.RegisterDto | kavita_client.models.register_dto.RegisterDto | kavita_client.models.register_dto.RegisterDto | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.user_dto.UserDto]

Register the first user (admin) on the server. Will not do anything if an admin is already confirmed

Args:

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