kavita_client.api.stream.post_api_stream_add_dashboard_stream

Module Contents

Functions

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

API

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

Creates a Dashboard Stream from a SmartFilter and adds it to the user’s dashboard 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:

DashboardStreamDto

async kavita_client.api.stream.post_api_stream_add_dashboard_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.dashboard_stream_dto.DashboardStreamDto]

Creates a Dashboard Stream from a SmartFilter and adds it to the user’s dashboard 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[DashboardStreamDto]

kavita_client.api.stream.post_api_stream_add_dashboard_stream.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, smart_filter_id: int | kavita_client.types.Unset = UNSET) → kavita_client.models.dashboard_stream_dto.DashboardStreamDto | None

Creates a Dashboard Stream from a SmartFilter and adds it to the user’s dashboard 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:

DashboardStreamDto

kavita_client.api.stream.post_api_stream_add_dashboard_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.dashboard_stream_dto.DashboardStreamDto]

Creates a Dashboard Stream from a SmartFilter and adds it to the user’s dashboard 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[DashboardStreamDto]