kavita_client.api.users.get_api_users_names

Module Contents

Functions

asyncio

Returns a list of the user names within the system

asyncio_detailed

Returns a list of the user names within the system

sync

Returns a list of the user names within the system

sync_detailed

Returns a list of the user names within the system

API

async kavita_client.api.users.get_api_users_names.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → list[str] | None

Returns a list of the user names within the system

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:

list[str]

async kavita_client.api.users.get_api_users_names.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → kavita_client.types.Response[list[str]]

Returns a list of the user names within the system

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[list[str]]

kavita_client.api.users.get_api_users_names.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → list[str] | None

Returns a list of the user names within the system

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:

list[str]

kavita_client.api.users.get_api_users_names.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → kavita_client.types.Response[list[str]]

Returns a list of the user names within the system

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[list[str]]