kavita_client.api.stream.post_api_stream_add_sidenav_stream

Module Contents

Functions

asyncio	Creates a SideNav Stream from a SmartFilter and adds it to the user’s sidenav as visible
asyncio_detailed	Creates a SideNav Stream from a SmartFilter and adds it to the user’s sidenav as visible
sync	Creates a SideNav Stream from a SmartFilter and adds it to the user’s sidenav as visible
sync_detailed	Creates a SideNav Stream from a SmartFilter and adds it to the user’s sidenav as visible

API

async kavita_client.api.stream.post_api_stream_add_sidenav_stream.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, smart_filter_id: int | kavita_client.types.Unset = UNSET) → kavita_client.models.side_nav_stream_dto.SideNavStreamDto | None

Creates a SideNav Stream from a SmartFilter and adds it to the user’s sidenav as visible

Args:

smart_filter_id (int | 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:

SideNavStreamDto

async kavita_client.api.stream.post_api_stream_add_sidenav_stream.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, smart_filter_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.side_nav_stream_dto.SideNavStreamDto]

Creates a SideNav Stream from a SmartFilter and adds it to the user’s sidenav as visible

Args:

smart_filter_id (int | 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[SideNavStreamDto]

kavita_client.api.stream.post_api_stream_add_sidenav_stream.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, smart_filter_id: int | kavita_client.types.Unset = UNSET) → kavita_client.models.side_nav_stream_dto.SideNavStreamDto | None

Creates a SideNav Stream from a SmartFilter and adds it to the user’s sidenav as visible

Args:

smart_filter_id (int | 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:

SideNavStreamDto

kavita_client.api.stream.post_api_stream_add_sidenav_stream.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, smart_filter_id: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[kavita_client.models.side_nav_stream_dto.SideNavStreamDto]

Creates a SideNav Stream from a SmartFilter and adds it to the user’s sidenav as visible

Args:

smart_filter_id (int | 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[SideNavStreamDto]