paperap.models.ui_settings.model module

METADATA:

File: ui_settings.py
Project: paperap

Created: 2025-03-04
Version: 0.0.5

Author: Jess Mann Email: jess@jmann.me

Copyright (c) 2025 Jess Mann

LAST MODIFIED:

2025-03-04 By Jess Mann

class paperap.models.ui_settings.model.UISettings(**data)[source]

Bases: StandardModel

Represents UI settings in Paperless-NgX.

Parameters:: data (Any)

user: dict[str, Any]

settings: dict[str, Any]

permissions: list[str]

class Meta(model)[source]

Bases: Meta

Parameters:: model (type[_Self])

queryset: alias of UISettingsQuerySet

blacklist_filtering_params: ClassVar[set[str]] = {}

field_map: dict[str, str] = {}

filtering_disabled: ClassVar[set[str]] = {}

filtering_fields: ClassVar[set[str]] = {'_resource', 'id', 'permissions', 'settings', 'user'}

read_only_fields: ClassVar[set[str]] = {'id'}

supported_filtering_params: ClassVar[set[str]] = {'id', 'id__in', 'limit'}

model: type[_Self]

name: str

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'ignore', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_default': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(context: Any, /) → None

We need to both initialize private attributes and call the user-defined model_post_init method.

Parameters:

self (BaseModel)
context (Any)

Return type:

id: int