kavita_client.api.cbl.get_api_cbl_browse

Module Contents

Functions

asyncio	Provides the browse CBL Repo interface. Requires Download role.
asyncio_detailed	Provides the browse CBL Repo interface. Requires Download role.
sync	Provides the browse CBL Repo interface. Requires Download role.
sync_detailed	Provides the browse CBL Repo interface. Requires Download role.

API

async kavita_client.api.cbl.get_api_cbl_browse.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, path: str | kavita_client.types.Unset = '') → kavita_client.models.cbl_repo_browse_result_dto.CblRepoBrowseResultDto | None

Provides the browse CBL Repo interface. Requires Download role.

Args:

path (str | Unset): Default: ‘’.

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:

CblRepoBrowseResultDto

async kavita_client.api.cbl.get_api_cbl_browse.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, path: str | kavita_client.types.Unset = '') → kavita_client.types.Response[kavita_client.models.cbl_repo_browse_result_dto.CblRepoBrowseResultDto]

Provides the browse CBL Repo interface. Requires Download role.

Args:

path (str | Unset): Default: ‘’.

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

kavita_client.api.cbl.get_api_cbl_browse.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, path: str | kavita_client.types.Unset = '') → kavita_client.models.cbl_repo_browse_result_dto.CblRepoBrowseResultDto | None

Provides the browse CBL Repo interface. Requires Download role.

Args:

path (str | Unset): Default: ‘’.

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:

CblRepoBrowseResultDto

kavita_client.api.cbl.get_api_cbl_browse.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, path: str | kavita_client.types.Unset = '') → kavita_client.types.Response[kavita_client.models.cbl_repo_browse_result_dto.CblRepoBrowseResultDto]

Provides the browse CBL Repo interface. Requires Download role.

Args:

path (str | Unset): Default: ‘’.

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