kavita_client.api.account.post_api_account_invite

Module Contents

Functions

asyncio	Invites a user to the server. Will generate a setup link for continuing setup. If email is not setup, a link will be presented to user to continue setup.
asyncio_detailed	Invites a user to the server. Will generate a setup link for continuing setup. If email is not setup, a link will be presented to user to continue setup.
sync	Invites a user to the server. Will generate a setup link for continuing setup. If email is not setup, a link will be presented to user to continue setup.
sync_detailed	Invites a user to the server. Will generate a setup link for continuing setup. If email is not setup, a link will be presented to user to continue setup.

API

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

Invites a user to the server. Will generate a setup link for continuing setup. If email is not setup, a link will be presented to user to continue setup.

Args:

body (InviteUserDto | Unset): body (InviteUserDto | Unset): body (InviteUserDto | 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_invite.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.invite_user_dto.InviteUserDto | kavita_client.models.invite_user_dto.InviteUserDto | kavita_client.models.invite_user_dto.InviteUserDto | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.invite_user_response.InviteUserResponse]

Invites a user to the server. Will generate a setup link for continuing setup. If email is not setup, a link will be presented to user to continue setup.

Args:

body (InviteUserDto | Unset): body (InviteUserDto | Unset): body (InviteUserDto | 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_invite.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.invite_user_dto.InviteUserDto | kavita_client.models.invite_user_dto.InviteUserDto | kavita_client.models.invite_user_dto.InviteUserDto | kavita_client.types.Unset = UNSET) → kavita_client.models.invite_user_response.InviteUserResponse | None

Invites a user to the server. Will generate a setup link for continuing setup. If email is not setup, a link will be presented to user to continue setup.

Args:

body (InviteUserDto | Unset): body (InviteUserDto | Unset): body (InviteUserDto | 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_invite.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.invite_user_dto.InviteUserDto | kavita_client.models.invite_user_dto.InviteUserDto | kavita_client.models.invite_user_dto.InviteUserDto | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.invite_user_response.InviteUserResponse]

Invites a user to the server. Will generate a setup link for continuing setup. If email is not setup, a link will be presented to user to continue setup.

Args:

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