kavita_client.api.locale.get_api_locale

Module Contents

Functions

asyncio	Returns all applicable locales on the server
asyncio_detailed	Returns all applicable locales on the server
sync	Returns all applicable locales on the server
sync_detailed	Returns all applicable locales on the server

API

async kavita_client.api.locale.get_api_locale.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → list[kavita_client.models.kavita_locale.KavitaLocale] | None

Returns all applicable locales on the server

This can be cached as it will not change per version.

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[KavitaLocale]

async kavita_client.api.locale.get_api_locale.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → kavita_client.types.Response[list[kavita_client.models.kavita_locale.KavitaLocale]]

Returns all applicable locales on the server

This can be cached as it will not change per version.

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[KavitaLocale]]

kavita_client.api.locale.get_api_locale.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → list[kavita_client.models.kavita_locale.KavitaLocale] | None

Returns all applicable locales on the server

This can be cached as it will not change per version.

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[KavitaLocale]

kavita_client.api.locale.get_api_locale.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client) → kavita_client.types.Response[list[kavita_client.models.kavita_locale.KavitaLocale]]

Returns all applicable locales on the server

This can be cached as it will not change per version.

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[KavitaLocale]]