kavita_client.api.scrobbling.post_api_scrobbling_scrobble_events

Module Contents

Functions

asyncio	Returns the scrobbling history for the user
asyncio_detailed	Returns the scrobbling history for the user
sync	Returns the scrobbling history for the user
sync_detailed	Returns the scrobbling history for the user

API

async kavita_client.api.scrobbling.post_api_scrobbling_scrobble_events.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.scrobble_event_filter.ScrobbleEventFilter | kavita_client.models.scrobble_event_filter.ScrobbleEventFilter | kavita_client.models.scrobble_event_filter.ScrobbleEventFilter | kavita_client.types.Unset = UNSET, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET) → list[kavita_client.models.scrobble_event_dto.ScrobbleEventDto] | None

Returns the scrobbling history for the user

User must have a valid license

Args:

page_number (int | Unset): page_size (int | Unset): body (ScrobbleEventFilter | Unset): body (ScrobbleEventFilter | Unset): body (ScrobbleEventFilter | 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:

list[ScrobbleEventDto]

async kavita_client.api.scrobbling.post_api_scrobbling_scrobble_events.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.scrobble_event_filter.ScrobbleEventFilter | kavita_client.models.scrobble_event_filter.ScrobbleEventFilter | kavita_client.models.scrobble_event_filter.ScrobbleEventFilter | kavita_client.types.Unset = UNSET, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.scrobble_event_dto.ScrobbleEventDto]]

Returns the scrobbling history for the user

User must have a valid license

Args:

page_number (int | Unset): page_size (int | Unset): body (ScrobbleEventFilter | Unset): body (ScrobbleEventFilter | Unset): body (ScrobbleEventFilter | 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[list[ScrobbleEventDto]]

kavita_client.api.scrobbling.post_api_scrobbling_scrobble_events.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.scrobble_event_filter.ScrobbleEventFilter | kavita_client.models.scrobble_event_filter.ScrobbleEventFilter | kavita_client.models.scrobble_event_filter.ScrobbleEventFilter | kavita_client.types.Unset = UNSET, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET) → list[kavita_client.models.scrobble_event_dto.ScrobbleEventDto] | None

Returns the scrobbling history for the user

User must have a valid license

Args:

page_number (int | Unset): page_size (int | Unset): body (ScrobbleEventFilter | Unset): body (ScrobbleEventFilter | Unset): body (ScrobbleEventFilter | 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:

list[ScrobbleEventDto]

kavita_client.api.scrobbling.post_api_scrobbling_scrobble_events.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, body: kavita_client.models.scrobble_event_filter.ScrobbleEventFilter | kavita_client.models.scrobble_event_filter.ScrobbleEventFilter | kavita_client.models.scrobble_event_filter.ScrobbleEventFilter | kavita_client.types.Unset = UNSET, page_number: int | kavita_client.types.Unset = UNSET, page_size: int | kavita_client.types.Unset = UNSET) → kavita_client.types.Response[list[kavita_client.models.scrobble_event_dto.ScrobbleEventDto]]

Returns the scrobbling history for the user

User must have a valid license

Args:

page_number (int | Unset): page_size (int | Unset): body (ScrobbleEventFilter | Unset): body (ScrobbleEventFilter | Unset): body (ScrobbleEventFilter | 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[list[ScrobbleEventDto]]