paperap.models.saved_view.model module


METADATA:

File: saved_view.py

Project: paperap

Created: 2025-03-04

Version: 0.0.9

Author: Jess Mann Email: jess@jmann.me

Copyright (c) 2025 Jess Mann


LAST MODIFIED:

2025-03-04 By Jess Mann

class paperap.models.saved_view.model.SavedView(**data)[source]

Bases: StandardModel

Represents a saved view in Paperless-NgX.

Parameters:

data (Any)

name: str
show_on_dashboard: bool | None
show_in_sidebar: bool | None
sort_field: str | None
sort_reverse: bool | None
filter_rules: list[SavedViewFilterRuleType]
page_size: int | None
display_mode: SavedViewDisplayModeType | None
display_fields: list[SavedViewDisplayFieldType]
owner: int | None
user_can_change: bool | None
class Meta(model)[source]

Bases: Meta

Parameters:

model (type[_Self])

read_only_fields: ClassVar[set[str]] = {'id', 'owner', 'user_can_change'}
queryset

alias of SavedViewQuerySet

blacklist_filtering_params: ClassVar[set[str]] = {}
field_map: dict[str, str] = {}
filtering_disabled: ClassVar[set[str]] = {}
filtering_fields: ClassVar[set[str]] = {'_resource', 'display_fields', 'display_mode', 'filter_rules', 'id', 'name', 'owner', 'page_size', 'show_in_sidebar', 'show_on_dashboard', 'sort_field', 'sort_reverse', 'user_can_change'}
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:
Return type:

None

id: int