kavita_client.api.collection.get_api_collection_name_exists

Module Contents

Functions

asyncio	Checks if a collection exists with the name
asyncio_detailed	Checks if a collection exists with the name
sync	Checks if a collection exists with the name
sync_detailed	Checks if a collection exists with the name

API

async kavita_client.api.collection.get_api_collection_name_exists.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, name: str | kavita_client.types.Unset = UNSET) → bool | None

Checks if a collection exists with the name

Args:

name (str | 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.collection.get_api_collection_name_exists.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, name: str | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[bool]

Checks if a collection exists with the name

Args:

name (str | 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.collection.get_api_collection_name_exists.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, name: str | kavita_client.types.Unset = UNSET) → bool | None

Checks if a collection exists with the name

Args:

name (str | 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.collection.get_api_collection_name_exists.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, name: str | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[bool]

Checks if a collection exists with the name

Args:

name (str | 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]