kavita_client.api.device.get_api_device_client_devices

Module Contents

Functions

asyncio	Get my client devices
asyncio_detailed	Get my client devices
sync	Get my client devices
sync_detailed	Get my client devices

API

async kavita_client.api.device.get_api_device_client_devices.asyncio(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, include_inactive: bool | kavita_client.types.Unset = False) → list[kavita_client.models.client_device_dto.ClientDeviceDto] | None

Get my client devices

Args:

include_inactive (bool | Unset): Default: False.

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

async kavita_client.api.device.get_api_device_client_devices.asyncio_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, include_inactive: bool | kavita_client.types.Unset = False) → kavita_client.types.Response[list[kavita_client.models.client_device_dto.ClientDeviceDto]]

Get my client devices

Args:

include_inactive (bool | Unset): Default: False.

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

kavita_client.api.device.get_api_device_client_devices.sync(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, include_inactive: bool | kavita_client.types.Unset = False) → list[kavita_client.models.client_device_dto.ClientDeviceDto] | None

Get my client devices

Args:

include_inactive (bool | Unset): Default: False.

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

kavita_client.api.device.get_api_device_client_devices.sync_detailed(*, client: kavita_client.client.AuthenticatedClient | kavita_client.client.Client, include_inactive: bool | kavita_client.types.Unset = False) → kavita_client.types.Response[list[kavita_client.models.client_device_dto.ClientDeviceDto]]

Get my client devices

Args:

include_inactive (bool | Unset): Default: False.

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