kavita_client.api.person.post_api_person_valid_alias

Module Contents

Functions

asyncio	Ensure the alias is valid to be added. For example, the alias cannot be on another person or be the same as the current person name/alias.
asyncio_detailed	Ensure the alias is valid to be added. For example, the alias cannot be on another person or be the same as the current person name/alias.
sync	Ensure the alias is valid to be added. For example, the alias cannot be on another person or be the same as the current person name/alias.
sync_detailed	Ensure the alias is valid to be added. For example, the alias cannot be on another person or be the same as the current person name/alias.

API

async kavita_client.api.person.post_api_person_valid_alias.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.person_alias_check_dto.PersonAliasCheckDto | kavita_client.models.person_alias_check_dto.PersonAliasCheckDto | kavita_client.models.person_alias_check_dto.PersonAliasCheckDto | kavita_client.types.Unset = UNSET) → bool | None

Ensure the alias is valid to be added. For example, the alias cannot be on another person or be the same as the current person name/alias.

Args:

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

bool

async kavita_client.api.person.post_api_person_valid_alias.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.person_alias_check_dto.PersonAliasCheckDto | kavita_client.models.person_alias_check_dto.PersonAliasCheckDto | kavita_client.models.person_alias_check_dto.PersonAliasCheckDto | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[bool]

Ensure the alias is valid to be added. For example, the alias cannot be on another person or be the same as the current person name/alias.

Args:

body (PersonAliasCheckDto | Unset): body (PersonAliasCheckDto | Unset): body (PersonAliasCheckDto | 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[bool]

kavita_client.api.person.post_api_person_valid_alias.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.person_alias_check_dto.PersonAliasCheckDto | kavita_client.models.person_alias_check_dto.PersonAliasCheckDto | kavita_client.models.person_alias_check_dto.PersonAliasCheckDto | kavita_client.types.Unset = UNSET) → bool | None

Ensure the alias is valid to be added. For example, the alias cannot be on another person or be the same as the current person name/alias.

Args:

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

bool

kavita_client.api.person.post_api_person_valid_alias.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.person_alias_check_dto.PersonAliasCheckDto | kavita_client.models.person_alias_check_dto.PersonAliasCheckDto | kavita_client.models.person_alias_check_dto.PersonAliasCheckDto | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[bool]

Ensure the alias is valid to be added. For example, the alias cannot be on another person or be the same as the current person name/alias.

Args:

body (PersonAliasCheckDto | Unset): body (PersonAliasCheckDto | Unset): body (PersonAliasCheckDto | 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[bool]