paperap.models.responses.list module
METADATA:
File: list.py Project: paperap Created: 2025-03-11 Version: 0.0.5 Author: Jess Mann Email: jess@jmann.me Copyright (c) 2025 Jess Mann
LAST MODIFIED:
2025-03-11 By Jess Mann
- class paperap.models.responses.list.ListResponse(**data)[source]
Bases:
StandardModelNot currently used, but kept for documentation or future expansion.
The structure of an api response from paperless ngx for a list of models.
- Parameters:
data (
Any)
- count: int
- next: str | None
- previous: str | None
- all: list[int]
- results: list[StandardModel]
- class Meta(model)
Bases:
Meta- Parameters:
model (type[_Self])
- blacklist_filtering_params: ClassVar[set[str]] = {}
- field_map: dict[str, str] = {}
- filtering_disabled: ClassVar[set[str]] = {}
- filtering_fields: ClassVar[set[str]] = {'_resource', 'all', 'count', 'id', 'next', 'previous', 'results'}
- read_only_fields: ClassVar[set[str]] = {'id'}
- supported_filtering_params: ClassVar[set[str]] = {'id', 'id__in', 'limit'}
- 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].