paperap.models.workflow.queryset module

METADATA:

File: queryset.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.workflow.queryset.WorkflowQuerySet(resource, filters=None, _cache=None, _fetch_all=False, _next_url=None, _last_response=None, _iter=None, _urls_fetched=None)[source]

Bases: StandardQuerySet[Workflow]

A lazy-loaded, chainable query interface for Paperless NGX resources.

BaseQuerySet provides pagination, filtering, and caching functionality similar to Django’s BaseQuerySet. It’s designed to be lazy - only fetching data when it’s actually needed.

Parameters:

  • resource (BaseResource[_Model, Self])

  • filters (dict[str, Any] | None)

  • _cache (list[_Model] | None)

  • _fetch_all (bool)

  • _next_url (str | None)

  • _last_response (ClientResponse)

  • _iter (Iterator[_Model] | None)

  • _urls_fetched (list[str] | None)

name(value, *, exact=True, case_insensitive=True)[source]

Filter workflows by name.

Parameters:

  • value (str) – The workflow name to filter by

  • exact (bool) – If True, match the exact name, otherwise use contains

  • case_insensitive (bool) – If True, ignore case when matching

Return type:

Self

Returns:

Filtered WorkflowQuerySet

order(value)[source]

Filter workflows by order.

Parameters:

value (int) – The order value to filter by

Return type:

Self

Returns:

Filtered WorkflowQuerySet

enabled(value=True)[source]

Filter workflows by enabled status.

Parameters:

value (bool) – If True, get enabled workflows, otherwise disabled

Return type:

Self

Returns:

Filtered WorkflowQuerySet

class paperap.models.workflow.queryset.WorkflowActionQuerySet(resource, filters=None, _cache=None, _fetch_all=False, _next_url=None, _last_response=None, _iter=None, _urls_fetched=None)[source]

Bases: StandardQuerySet[WorkflowAction]

A lazy-loaded, chainable query interface for Paperless NGX resources.

BaseQuerySet provides pagination, filtering, and caching functionality similar to Django’s BaseQuerySet. It’s designed to be lazy - only fetching data when it’s actually needed.

Parameters:

  • resource (BaseResource[_Model, Self])

  • filters (dict[str, Any] | None)

  • _cache (list[_Model] | None)

  • _fetch_all (bool)

  • _next_url (str | None)

  • _last_response (ClientResponse)

  • _iter (Iterator[_Model] | None)

  • _urls_fetched (list[str] | None)

type(value, *, exact=True, case_insensitive=True)[source]

Filter workflow actions by type.

Parameters:

  • value (str) – The action type to filter by

  • exact (bool) – If True, match the exact type, otherwise use contains

  • case_insensitive (bool) – If True, ignore case when matching

Return type:

Self

Returns:

Filtered WorkflowActionQuerySet

assign_title(value, *, exact=True, case_insensitive=True)[source]

Filter workflow actions by assigned title.

Parameters:

  • value (str) – The title to filter by

  • exact (bool) – If True, match the exact title, otherwise use contains

  • case_insensitive (bool) – If True, ignore case when matching

Return type:

Self

Returns:

Filtered WorkflowActionQuerySet

assign_tags(value)[source]

Filter workflow actions by assigned tags.

Parameters:

value (int | list[int]) – The tag ID or list of tag IDs to filter by

Return type:

Self

Returns:

Filtered WorkflowActionQuerySet

assign_correspondent(value)[source]

Filter workflow actions by assigned correspondent.

Parameters:

value (int) – The correspondent ID to filter by

Return type:

Self

Returns:

Filtered WorkflowActionQuerySet

assign_document_type(value)[source]

Filter workflow actions by assigned document type.

Parameters:

value (int) – The document type ID to filter by

Return type:

Self

Returns:

Filtered WorkflowActionQuerySet

assign_storage_path(value)[source]

Filter workflow actions by assigned storage path.

Parameters:

value (int) – The storage path ID to filter by

Return type:

Self

Returns:

Filtered WorkflowActionQuerySet

assign_owner(value)[source]

Filter workflow actions by assigned owner.

Parameters:

value (int) – The owner ID to filter by

Return type:

Self

Returns:

Filtered WorkflowActionQuerySet

class paperap.models.workflow.queryset.WorkflowTriggerQuerySet(resource, filters=None, _cache=None, _fetch_all=False, _next_url=None, _last_response=None, _iter=None, _urls_fetched=None)[source]

Bases: StandardQuerySet[WorkflowTrigger]

A lazy-loaded, chainable query interface for Paperless NGX resources.

BaseQuerySet provides pagination, filtering, and caching functionality similar to Django’s BaseQuerySet. It’s designed to be lazy - only fetching data when it’s actually needed.

Parameters:

  • resource (BaseResource[_Model, Self])

  • filters (dict[str, Any] | None)

  • _cache (list[_Model] | None)

  • _fetch_all (bool)

  • _next_url (str | None)

  • _last_response (ClientResponse)

  • _iter (Iterator[_Model] | None)

  • _urls_fetched (list[str] | None)

type(value)[source]

Filter workflow triggers by type.

Parameters:

value (int) – The trigger type to filter by

Return type:

Self

Returns:

Filtered WorkflowTriggerQuerySet

filter_path(value, *, exact=True, case_insensitive=True)[source]

Filter workflow triggers by path filter.

Parameters:

  • value (str) – The path filter to match

  • exact (bool) – If True, match the exact path, otherwise use contains

  • case_insensitive (bool) – If True, ignore case when matching

Return type:

Self

Returns:

Filtered WorkflowTriggerQuerySet

filter_filename(value, *, exact=True, case_insensitive=True)[source]

Filter workflow triggers by filename filter.

Parameters:

  • value (str) – The filename filter to match

  • exact (bool) – If True, match the exact filename, otherwise use contains

  • case_insensitive (bool) – If True, ignore case when matching

Return type:

Self

Returns:

Filtered WorkflowTriggerQuerySet

filter_mailrule(value, *, exact=True, case_insensitive=True)[source]

Filter workflow triggers by mail rule filter.

Parameters:

  • value (str) – The mail rule filter to match

  • exact (bool) – If True, match the exact mail rule, otherwise use contains

  • case_insensitive (bool) – If True, ignore case when matching

Return type:

Self

Returns:

Filtered WorkflowTriggerQuerySet

has_tags(value)[source]

Filter workflow triggers by tags filter.

Parameters:

value (int | list[int]) – The tag ID or list of tag IDs to filter by

Return type:

Self

Returns:

Filtered WorkflowTriggerQuerySet

has_correspondent(value)[source]

Filter workflow triggers by correspondent filter.

Parameters:

value (int) – The correspondent ID to filter by

Return type:

Self

Returns:

Filtered WorkflowTriggerQuerySet

has_document_type(value)[source]

Filter workflow triggers by document type filter.

Parameters:

value (int) – The document type ID to filter by

Return type:

Self

Returns:

Filtered WorkflowTriggerQuerySet