paperap.resources.ui_settings module

---

METADATA:

File: ui_settings.py Project: paperap Created: 2025-03-21 Version: 0.0.9 Author: Jess Mann Email: jess@jmann.me Copyright (c) 2025 Jess Mann

---

LAST MODIFIED:

2025-03-21 By Jess Mann

class paperap.resources.ui_settings.UISettingsResource(client)

Bases: StandardResource[UISettings, UISettingsQuerySet]

Resource for managing UI settings.

Parameters:

client (PaperlessClient)

model_class

alias of UISettings

queryset_class

alias of UISettingsQuerySet

name: str = 'ui_settings'

get_current()

Get the current user’s UI settings.

Return type:

UISettings | None

Returns:

The current user’s UI settings.

update_current(settings)

Update the current user’s UI settings.

Parameters:

settings (dict[str, Any]) – The settings to update.

Return type:

UISettings

Returns:

The updated UI settings.

delete(model_id)

Delete a resource.

Parameters:

model_id (int | UISettings) – ID of the resource.

Return type:

None

endpoints: ClassVar[Endpoints] = {'create': <string.Template object>, 'delete': <string.Template object>, 'detail': <string.Template object>, 'list': <string.Template object>, 'update': <string.Template object>}

client: PaperlessClient